MembersApi

All URIs are relative to https://api.configcat.com

Method	HTTP request	Description
addMemberToGroup	POST /v1/organizations/{organizationId}/members/{userId}	Update Member Permissions
deleteInvitation	DELETE /v1/invitations/{invitationId}	Delete Invitation
deleteOrganizationMember	DELETE /v1/organizations/{organizationId}/members/{userId}	Delete Member from Organization
deleteProductMember	DELETE /v1/products/{productId}/members/{userId}	Delete Member from Product
getOrganizationMembers	GET /v1/organizations/{organizationId}/members	List Organization Members
getOrganizationMembersV2	GET /v2/organizations/{organizationId}/members	List Organization Members
getPendingInvitations	GET /v1/products/{productId}/invitations	List Pending Invitations in Product
getPendingInvitationsOrg	GET /v1/organizations/{organizationId}/invitations	List Pending Invitations in Organization
getProductMembers	GET /v1/products/{productId}/members	List Product Members
inviteMember	POST /v1/products/{productId}/members/invite	Invite Member

addMemberToGroup

addMemberToGroup(organizationId, userId, updateMemberPermissionsRequest)

Update Member Permissions

This endpoint updates the permissions of a Member identified by the `userId`. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID organizationId = UUID.randomUUID(); // UUID | The identifier of the Organization.
    String userId = "userId_example"; // String | The identifier of the Member.
    UpdateMemberPermissionsRequest updateMemberPermissionsRequest = new UpdateMemberPermissionsRequest(); // UpdateMemberPermissionsRequest | 
    try {
      apiInstance.addMemberToGroup(organizationId, userId, updateMemberPermissionsRequest);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#addMemberToGroup");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
organizationId	UUID	The identifier of the Organization.
userId	String	The identifier of the Member.
updateMemberPermissionsRequest	UpdateMemberPermissionsRequest

Return type

null (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteInvitation

deleteInvitation(invitationId)

Delete Invitation

This endpoint removes an Invitation identified by the `invitationId` parameter.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID invitationId = UUID.randomUUID(); // UUID | The identifier of the Invitation.
    try {
      apiInstance.deleteInvitation(invitationId);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#deleteInvitation");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
invitationId	UUID	The identifier of the Invitation.

Return type

null (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteOrganizationMember

deleteOrganizationMember(organizationId, userId)

Delete Member from Organization

This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID organizationId = UUID.randomUUID(); // UUID | The identifier of the Organization.
    String userId = "userId_example"; // String | The identifier of the Member.
    try {
      apiInstance.deleteOrganizationMember(organizationId, userId);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#deleteOrganizationMember");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
organizationId	UUID	The identifier of the Organization.
userId	String	The identifier of the Member.

Return type

null (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteProductMember

deleteProductMember(productId, userId)

Delete Member from Product

This endpoint removes a Member identified by the `userId` from the given Product identified by the `productId` parameter.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID productId = UUID.randomUUID(); // UUID | The identifier of the Product.
    String userId = "userId_example"; // String | The identifier of the Member.
    try {
      apiInstance.deleteProductMember(productId, userId);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#deleteProductMember");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
productId	UUID	The identifier of the Product.
userId	String	The identifier of the Member.

Return type

null (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembers

List<UserModel> getOrganizationMembers(organizationId)

List Organization Members

This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter. The results may vary based on the access level of the user who calls the endpoint: - When it's called with Organization Admin privileges, the result will contain each member in the Organization. - When it's called without Organization Admin privileges, the result will contain each Organization Admin along with members of those products where the caller has `Team members and permission groups` (`canManageMembers`) permission.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID organizationId = UUID.randomUUID(); // UUID | The identifier of the Organization.
    try {
      List<UserModel> result = apiInstance.getOrganizationMembers(organizationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#getOrganizationMembers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
organizationId	UUID	The identifier of the Organization.

Return type

List<UserModel>

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getOrganizationMembersV2

OrganizationMembersModel getOrganizationMembersV2(organizationId)

List Organization Members

This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter. The results may vary based on the access level of the user who calls the endpoint: - When it's called with Organization Admin privileges, the result will contain each member in the Organization. - When it's called without Organization Admin privileges, the result will contain each Organization Admin along with members of those products where the caller has `Team members and permission groups` (`canManageMembers`) permission.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID organizationId = UUID.randomUUID(); // UUID | The identifier of the Organization.
    try {
      OrganizationMembersModel result = apiInstance.getOrganizationMembersV2(organizationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#getOrganizationMembersV2");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
organizationId	UUID	The identifier of the Organization.

Return type

OrganizationMembersModel

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitations

List<InvitationModel> getPendingInvitations(productId)

List Pending Invitations in Product

This endpoint returns the list of pending invitations within the given Product identified by the `productId` parameter.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID productId = UUID.randomUUID(); // UUID | The identifier of the Product.
    try {
      List<InvitationModel> result = apiInstance.getPendingInvitations(productId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#getPendingInvitations");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
productId	UUID	The identifier of the Product.

Return type

List<InvitationModel>

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getPendingInvitationsOrg

List<OrganizationInvitationModel> getPendingInvitationsOrg(organizationId)

List Pending Invitations in Organization

This endpoint returns the list of pending invitations within the given Organization identified by the `organizationId` parameter.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID organizationId = UUID.randomUUID(); // UUID | The identifier of the Organization.
    try {
      List<OrganizationInvitationModel> result = apiInstance.getPendingInvitationsOrg(organizationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#getPendingInvitationsOrg");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
organizationId	UUID	The identifier of the Organization.

Return type

List<OrganizationInvitationModel>

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductMembers

List<MemberModel> getProductMembers(productId)

List Product Members

This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID productId = UUID.randomUUID(); // UUID | The identifier of the Product.
    try {
      List<MemberModel> result = apiInstance.getProductMembers(productId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#getProductMembers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
productId	UUID	The identifier of the Product.

Return type

List<MemberModel>

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

inviteMember

inviteMember(productId, inviteMembersRequest)

Invite Member

This endpoint invites a Member into the given Product identified by the `productId` parameter.

Example

// Import classes:
import com.configcat.publicapi.java.client.ApiClient;
import com.configcat.publicapi.java.client.ApiException;
import com.configcat.publicapi.java.client.Configuration;
import com.configcat.publicapi.java.client.auth.*;
import com.configcat.publicapi.java.client.models.*;
import com.configcat.publicapi.java.client.api.MembersApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.configcat.com");
    
    // Configure HTTP basic authorization: Basic
    HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
    Basic.setUsername("YOUR USERNAME");
    Basic.setPassword("YOUR PASSWORD");

    MembersApi apiInstance = new MembersApi(defaultClient);
    UUID productId = UUID.randomUUID(); // UUID | The identifier of the Product.
    InviteMembersRequest inviteMembersRequest = new InviteMembersRequest(); // InviteMembersRequest | 
    try {
      apiInstance.inviteMember(productId, inviteMembersRequest);
    } catch (ApiException e) {
      System.err.println("Exception when calling MembersApi#inviteMember");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
productId	UUID	The identifier of the Product.
inviteMembersRequest	InviteMembersRequest

Return type

null (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: application/json, text/json, application/*+json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	When the invite was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

Files

MembersApi.md

Latest commit

History

MembersApi.md

File metadata and controls

MembersApi

addMemberToGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteInvitation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteOrganizationMember

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteProductMember

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getOrganizationMembers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getOrganizationMembersV2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getPendingInvitations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getPendingInvitationsOrg

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getProductMembers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inviteMember

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details