RolesApi

All URIs are relative to https://api.thousandeyes.com/v7

Method	HTTP request	Description
createRole	POST /roles	Create role
createRoleWithHttpInfo	POST /roles	Create role
deleteRole	DELETE /roles/{id}	Delete role
deleteRoleWithHttpInfo	DELETE /roles/{id}	Delete role
getRole	GET /roles/{id}	Retrieve role
getRoleWithHttpInfo	GET /roles/{id}	Retrieve role
getRoles	GET /roles	List roles
getRolesWithHttpInfo	GET /roles	List roles
updateRole	PUT /roles/{id}	Update role
updateRoleWithHttpInfo	PUT /roles/{id}	Update role

createRole

RoleDetail createRole(roleRequestBody, aid)

Create role

Creates a new role.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        RoleRequestBody roleRequestBody = new RoleRequestBody(); // RoleRequestBody | 
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            RoleDetail result = apiInstance.createRole(roleRequestBody, aid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#createRole");
            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
roleRequestBody	RoleRequestBody
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

RoleDetail

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
201	Created	* Location -
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

createRoleWithHttpInfo

ApiResponse createRole createRoleWithHttpInfo(roleRequestBody, aid)

Create role

Creates a new role.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        RoleRequestBody roleRequestBody = new RoleRequestBody(); // RoleRequestBody | 
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            ApiResponse<RoleDetail> response = apiInstance.createRoleWithHttpInfo(roleRequestBody, aid);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#createRole");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
roleRequestBody	RoleRequestBody
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

ApiResponse<RoleDetail>

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
201	Created	* Location -
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

deleteRole

void deleteRole(id, aid)

Delete role

Deletes a role using its ID. The user needs appropriate permissions to successfully call this operation.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        String id = "23"; // String | The ID of the desired role.
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            apiInstance.deleteRole(id, aid);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#deleteRole");
            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
id	String	The ID of the desired role.
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

null (empty response body)

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	No content	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

deleteRoleWithHttpInfo

ApiResponse deleteRole deleteRoleWithHttpInfo(id, aid)

Delete role

Deletes a role using its ID. The user needs appropriate permissions to successfully call this operation.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        String id = "23"; // String | The ID of the desired role.
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            ApiResponse<Void> response = apiInstance.deleteRoleWithHttpInfo(id, aid);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#deleteRole");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	The ID of the desired role.
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

ApiResponse

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	No content	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

getRole

RoleDetail getRole(id, aid)

Retrieve role

Returns detailed information about a role using its ID.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        String id = "23"; // String | The ID of the desired role.
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            RoleDetail result = apiInstance.getRole(id, aid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRole");
            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
id	String	The ID of the desired role.
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

RoleDetail

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

getRoleWithHttpInfo

ApiResponse getRole getRoleWithHttpInfo(id, aid)

Retrieve role

Returns detailed information about a role using its ID.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        String id = "23"; // String | The ID of the desired role.
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            ApiResponse<RoleDetail> response = apiInstance.getRoleWithHttpInfo(id, aid);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRole");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	The ID of the desired role.
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

ApiResponse<RoleDetail>

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

getRoles

Roles getRoles(aid)

List roles

Retrieves a list of defined roles visible to the current user.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            Roles result = apiInstance.getRoles(aid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRoles");
            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
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

Roles

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

getRolesWithHttpInfo

ApiResponse getRoles getRolesWithHttpInfo(aid)

List roles

Retrieves a list of defined roles visible to the current user.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            ApiResponse<Roles> response = apiInstance.getRolesWithHttpInfo(aid);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRoles");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

ApiResponse<Roles>

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

updateRole

RoleDetail updateRole(id, roleRequestBody, aid)

Update role

Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This operation does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions operation.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        String id = "23"; // String | The ID of the desired role.
        RoleRequestBody roleRequestBody = new RoleRequestBody(); // RoleRequestBody | 
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            RoleDetail result = apiInstance.updateRole(id, roleRequestBody, aid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#updateRole");
            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
id	String	The ID of the desired role.
roleRequestBody	RoleRequestBody
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

RoleDetail

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

updateRoleWithHttpInfo

ApiResponse updateRole updateRoleWithHttpInfo(id, roleRequestBody, aid)

Update role

Updates a user-defined role using its ID. When updating a role, the following applies: * The full list of permissions must be sent, This operation does not support delta-based grant or revoking of permissions. * Permission definitions and details can be obtained from the Permissions operation.

Example

// Import classes:
import com.thousandeyes.sdk.client.ApiClient;
import com.thousandeyes.sdk.common.ApiException;
import com.thousandeyes.sdk.common.ApiResponse;
import com.thousandeyes.sdk.account.management.Configuration;
import com.thousandeyes.sdk.account.management.authentication.*;
import com.thousandeyes.sdk.account.management.models.*;
import com.thousandeyes.sdk.account.management.administrative.RolesApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.thousandeyes.com/v7");
        
        // Configure HTTP bearer authorization: BearerAuth
        HttpBearerAuth BearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("BearerAuth");
        BearerAuth.setBearerToken("BEARER TOKEN");

        RolesApi apiInstance = new RolesApi(defaultClient);
        String id = "23"; // String | The ID of the desired role.
        RoleRequestBody roleRequestBody = new RoleRequestBody(); // RoleRequestBody | 
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            ApiResponse<RoleDetail> response = apiInstance.updateRoleWithHttpInfo(id, roleRequestBody, aid);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#updateRole");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	String	The ID of the desired role.
roleRequestBody	RoleRequestBody
aid	String	A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.	[optional]

Return type

ApiResponse<RoleDetail>

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/hal+json, application/json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

Files

RolesApi.md

Latest commit

History

RolesApi.md

File metadata and controls

RolesApi

createRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createRoleWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteRoleWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRoleWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRoles

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getRolesWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateRoleWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details