Skip to content

PermissionGroupsApi.md

Latest commit

 

History

History
371 lines (287 loc) · 13.5 KB

PermissionGroupsApi.md

File metadata and controls

371 lines (287 loc) · 13.5 KB
Raw

PermissionGroupsApi

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

Method HTTP request Description
createPermissionGroup POST /v1/products/{productId}/permissions Create Permission Group
deletePermissionGroup DELETE /v1/permissions/{permissionGroupId} Delete Permission Group
getPermissionGroup GET /v1/permissions/{permissionGroupId} Get Permission Group
getPermissionGroups GET /v1/products/{productId}/permissions List Permission Groups
updatePermissionGroup PUT /v1/permissions/{permissionGroupId} Update Permission Group

createPermissionGroup

PermissionGroupModel createPermissionGroup(productId, createPermissionGroupRequest)

Create Permission Group

This endpoint creates a new Permission Group in a specified Product identified by the `productId` parameter, which can be obtained from the List Products endpoint.

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.PermissionGroupsApi;

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");

    PermissionGroupsApi apiInstance = new PermissionGroupsApi(defaultClient);
    UUID productId = UUID.randomUUID(); // UUID | The identifier of the Product.
    CreatePermissionGroupRequest createPermissionGroupRequest = new CreatePermissionGroupRequest(); // CreatePermissionGroupRequest | 
    try {
      PermissionGroupModel result = apiInstance.createPermissionGroup(productId, createPermissionGroupRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PermissionGroupsApi#createPermissionGroup");
      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.
createPermissionGroupRequest CreatePermissionGroupRequest

Return type

PermissionGroupModel

Authorization

Basic

HTTP request headers

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

HTTP response details

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

deletePermissionGroup

deletePermissionGroup(permissionGroupId)

Delete Permission Group

This endpoint removes a Permission Group identified by the `permissionGroupId` 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.PermissionGroupsApi;

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");

    PermissionGroupsApi apiInstance = new PermissionGroupsApi(defaultClient);
    Long permissionGroupId = 56L; // Long | The identifier of the Permission Group.
    try {
      apiInstance.deletePermissionGroup(permissionGroupId);
    } catch (ApiException e) {
      System.err.println("Exception when calling PermissionGroupsApi#deletePermissionGroup");
      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
permissionGroupId Long The identifier of the Permission Group.

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. -

getPermissionGroup

PermissionGroupModel getPermissionGroup(permissionGroupId)

Get Permission Group

This endpoint returns the metadata of a Permission Group identified by the `permissionGroupId`.

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.PermissionGroupsApi;

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");

    PermissionGroupsApi apiInstance = new PermissionGroupsApi(defaultClient);
    Long permissionGroupId = 56L; // Long | The identifier of the Permission Group.
    try {
      PermissionGroupModel result = apiInstance.getPermissionGroup(permissionGroupId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PermissionGroupsApi#getPermissionGroup");
      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
permissionGroupId Long The identifier of the Permission Group.

Return type

PermissionGroupModel

Authorization

Basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 When everything is ok, the permission group data returned. -
400 Bad request. -
404 Not found. -
429 Too many requests. In case of the request rate exceeds the rate limits. -

getPermissionGroups

List<PermissionGroupModel> getPermissionGroups(productId)

List Permission Groups

This endpoint returns the list of the Permission Groups that belongs to the given Product identified by the `productId` parameter, which can be obtained from the List Products endpoint.

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.PermissionGroupsApi;

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");

    PermissionGroupsApi apiInstance = new PermissionGroupsApi(defaultClient);
    UUID productId = UUID.randomUUID(); // UUID | The identifier of the Product.
    try {
      List<PermissionGroupModel> result = apiInstance.getPermissionGroups(productId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PermissionGroupsApi#getPermissionGroups");
      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<PermissionGroupModel>

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. -

updatePermissionGroup

PermissionGroupModel updatePermissionGroup(permissionGroupId, updatePermissionGroupRequest)

Update Permission Group

This endpoint updates a Permission Group identified by the `permissionGroupId` 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.PermissionGroupsApi;

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");

    PermissionGroupsApi apiInstance = new PermissionGroupsApi(defaultClient);
    Long permissionGroupId = 56L; // Long | The identifier of the Permission Group.
    UpdatePermissionGroupRequest updatePermissionGroupRequest = new UpdatePermissionGroupRequest(); // UpdatePermissionGroupRequest | 
    try {
      PermissionGroupModel result = apiInstance.updatePermissionGroup(permissionGroupId, updatePermissionGroupRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PermissionGroupsApi#updatePermissionGroup");
      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
permissionGroupId Long The identifier of the Permission Group.
updatePermissionGroupRequest UpdatePermissionGroupRequest

Return type

PermissionGroupModel

Authorization

Basic

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • 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. -