Package com.datadog.api.client.v2.api

Class RolesApi

java.lang.Object

com.datadog.api.client.v2.api.RolesApi

@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class RolesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RolesApi.ListPermissionsOptionalParameters	Manage optional parameters to listPermissions.
static class	RolesApi.ListRolesOptionalParameters	Manage optional parameters to listRoles.
static class	RolesApi.ListRoleUsersOptionalParameters	Manage optional parameters to listRoleUsers.

Constructor Summary

Constructors

Constructor	Description
RolesApi()
RolesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
PermissionsResponse	addPermissionToRole(String roleId, RelationshipToPermission body)	Grant permission to a role.
CompletableFuture<PermissionsResponse>	addPermissionToRoleAsync(String roleId, RelationshipToPermission body)	Grant permission to a role.
ApiResponse<PermissionsResponse>	addPermissionToRoleWithHttpInfo(String roleId, RelationshipToPermission body)	Adds a permission to a role.
CompletableFuture<ApiResponse<PermissionsResponse>>	addPermissionToRoleWithHttpInfoAsync(String roleId, RelationshipToPermission body)	Grant permission to a role.
UsersResponse	addUserToRole(String roleId, RelationshipToUser body)	Add a user to a role.
CompletableFuture<UsersResponse>	addUserToRoleAsync(String roleId, RelationshipToUser body)	Add a user to a role.
ApiResponse<UsersResponse>	addUserToRoleWithHttpInfo(String roleId, RelationshipToUser body)	Adds a user to a role.
CompletableFuture<ApiResponse<UsersResponse>>	addUserToRoleWithHttpInfoAsync(String roleId, RelationshipToUser body)	Add a user to a role.
RoleResponse	cloneRole(String roleId, RoleCloneRequest body)	Create a new role by cloning an existing role.
CompletableFuture<RoleResponse>	cloneRoleAsync(String roleId, RoleCloneRequest body)	Create a new role by cloning an existing role.
ApiResponse<RoleResponse>	cloneRoleWithHttpInfo(String roleId, RoleCloneRequest body)	Clone an existing role
CompletableFuture<ApiResponse<RoleResponse>>	cloneRoleWithHttpInfoAsync(String roleId, RoleCloneRequest body)	Create a new role by cloning an existing role.
RoleCreateResponse	createRole(RoleCreateRequest body)	Create role.
CompletableFuture<RoleCreateResponse>	createRoleAsync(RoleCreateRequest body)	Create role.
ApiResponse<RoleCreateResponse>	createRoleWithHttpInfo(RoleCreateRequest body)	Create a new role for your organization.
CompletableFuture<ApiResponse<RoleCreateResponse>>	createRoleWithHttpInfoAsync(RoleCreateRequest body)	Create role.
void	deleteRole(String roleId)	Delete role.
CompletableFuture<Void>	deleteRoleAsync(String roleId)	Delete role.
ApiResponse<Void>	deleteRoleWithHttpInfo(String roleId)	Disables a role.
CompletableFuture<ApiResponse<Void>>	deleteRoleWithHttpInfoAsync(String roleId)	Delete role.
ApiClient	getApiClient()	Get the API client.
RoleResponse	getRole(String roleId)	Get a role.
CompletableFuture<RoleResponse>	getRoleAsync(String roleId)	Get a role.
ApiResponse<RoleResponse>	getRoleWithHttpInfo(String roleId)	Get a role in the organization specified by the role’s role_id.
CompletableFuture<ApiResponse<RoleResponse>>	getRoleWithHttpInfoAsync(String roleId)	Get a role.
PermissionsResponse	listPermissions()	List permissions.
PermissionsResponse	listPermissions(RolesApi.ListPermissionsOptionalParameters parameters)	List permissions.
CompletableFuture<PermissionsResponse>	listPermissionsAsync()	List permissions.
CompletableFuture<PermissionsResponse>	listPermissionsAsync(RolesApi.ListPermissionsOptionalParameters parameters)	List permissions.
ApiResponse<PermissionsResponse>	listPermissionsWithHttpInfo(RolesApi.ListPermissionsOptionalParameters parameters)	Returns a list of all permissions, including name, description, and ID.
CompletableFuture<ApiResponse<PermissionsResponse>>	listPermissionsWithHttpInfoAsync(RolesApi.ListPermissionsOptionalParameters parameters)	List permissions.
PermissionsResponse	listRolePermissions(String roleId)	List permissions for a role.
CompletableFuture<PermissionsResponse>	listRolePermissionsAsync(String roleId)	List permissions for a role.
ApiResponse<PermissionsResponse>	listRolePermissionsWithHttpInfo(String roleId)	Returns a list of all permissions for a single role.
CompletableFuture<ApiResponse<PermissionsResponse>>	listRolePermissionsWithHttpInfoAsync(String roleId)	List permissions for a role.
RolesResponse	listRoles()	List roles.
RolesResponse	listRoles(RolesApi.ListRolesOptionalParameters parameters)	List roles.
CompletableFuture<RolesResponse>	listRolesAsync()	List roles.
CompletableFuture<RolesResponse>	listRolesAsync(RolesApi.ListRolesOptionalParameters parameters)	List roles.
ApiResponse<RolesResponse>	listRolesWithHttpInfo(RolesApi.ListRolesOptionalParameters parameters)	Returns all roles, including their names and their unique identifiers.
CompletableFuture<ApiResponse<RolesResponse>>	listRolesWithHttpInfoAsync(RolesApi.ListRolesOptionalParameters parameters)	List roles.
RoleTemplateArray	listRoleTemplates()	List role templates.
CompletableFuture<RoleTemplateArray>	listRoleTemplatesAsync()	List role templates.
ApiResponse<RoleTemplateArray>	listRoleTemplatesWithHttpInfo()	List all role templates
CompletableFuture<ApiResponse<RoleTemplateArray>>	listRoleTemplatesWithHttpInfoAsync()	List role templates.
UsersResponse	listRoleUsers(String roleId)	Get all users of a role.
UsersResponse	listRoleUsers(String roleId, RolesApi.ListRoleUsersOptionalParameters parameters)	Get all users of a role.
CompletableFuture<UsersResponse>	listRoleUsersAsync(String roleId)	Get all users of a role.
CompletableFuture<UsersResponse>	listRoleUsersAsync(String roleId, RolesApi.ListRoleUsersOptionalParameters parameters)	Get all users of a role.
ApiResponse<UsersResponse>	listRoleUsersWithHttpInfo(String roleId, RolesApi.ListRoleUsersOptionalParameters parameters)	Gets all users of a role.
CompletableFuture<ApiResponse<UsersResponse>>	listRoleUsersWithHttpInfoAsync(String roleId, RolesApi.ListRoleUsersOptionalParameters parameters)	Get all users of a role.
PermissionsResponse	removePermissionFromRole(String roleId, RelationshipToPermission body)	Revoke permission.
CompletableFuture<PermissionsResponse>	removePermissionFromRoleAsync(String roleId, RelationshipToPermission body)	Revoke permission.
ApiResponse<PermissionsResponse>	removePermissionFromRoleWithHttpInfo(String roleId, RelationshipToPermission body)	Removes a permission from a role.
CompletableFuture<ApiResponse<PermissionsResponse>>	removePermissionFromRoleWithHttpInfoAsync(String roleId, RelationshipToPermission body)	Revoke permission.
UsersResponse	removeUserFromRole(String roleId, RelationshipToUser body)	Remove a user from a role.
CompletableFuture<UsersResponse>	removeUserFromRoleAsync(String roleId, RelationshipToUser body)	Remove a user from a role.
ApiResponse<UsersResponse>	removeUserFromRoleWithHttpInfo(String roleId, RelationshipToUser body)	Removes a user from a role.
CompletableFuture<ApiResponse<UsersResponse>>	removeUserFromRoleWithHttpInfoAsync(String roleId, RelationshipToUser body)	Remove a user from a role.
void	setApiClient(ApiClient apiClient)	Set the API client.
RoleUpdateResponse	updateRole(String roleId, RoleUpdateRequest body)	Update a role.
CompletableFuture<RoleUpdateResponse>	updateRoleAsync(String roleId, RoleUpdateRequest body)	Update a role.
ApiResponse<RoleUpdateResponse>	updateRoleWithHttpInfo(String roleId, RoleUpdateRequest body)	Edit a role.
CompletableFuture<ApiResponse<RoleUpdateResponse>>	updateRoleWithHttpInfoAsync(String roleId, RoleUpdateRequest body)	Update a role.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RolesApi

public RolesApi()

RolesApi

public RolesApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

addPermissionToRole

public PermissionsResponse addPermissionToRole(String roleId,
 RelationshipToPermission body)
                                        throws ApiException

Grant permission to a role.

See addPermissionToRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToPermission).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

PermissionsResponse

Throws:

ApiException - if fails to make API call

addPermissionToRoleAsync

public CompletableFuture<PermissionsResponse> addPermissionToRoleAsync(String roleId,
 RelationshipToPermission body)

Grant permission to a role.

See addPermissionToRoleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RelationshipToPermission).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<PermissionsResponse>

addPermissionToRoleWithHttpInfo

public ApiResponse<PermissionsResponse> addPermissionToRoleWithHttpInfo(String roleId,
 RelationshipToPermission body)
                                                                 throws ApiException

Adds a permission to a role.

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

ApiResponse<PermissionsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
404	Not found	-
429	Too many requests	-

addPermissionToRoleWithHttpInfoAsync

public CompletableFuture<ApiResponse<PermissionsResponse>> addPermissionToRoleWithHttpInfoAsync(String roleId,
 RelationshipToPermission body)

Grant permission to a role.

See addPermissionToRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToPermission).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<PermissionsResponse>>

addUserToRole

public UsersResponse addUserToRole(String roleId,
 RelationshipToUser body)
                            throws ApiException

Add a user to a role.

See addUserToRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToUser).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

UsersResponse

Throws:

ApiException - if fails to make API call

addUserToRoleAsync

public CompletableFuture<UsersResponse> addUserToRoleAsync(String roleId,
 RelationshipToUser body)

Add a user to a role.

See addUserToRoleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RelationshipToUser).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<UsersResponse>

addUserToRoleWithHttpInfo

public ApiResponse<UsersResponse> addUserToRoleWithHttpInfo(String roleId,
 RelationshipToUser body)
                                                     throws ApiException

Adds a user to a role.

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

ApiResponse<UsersResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
404	Not found	-
429	Too many requests	-

addUserToRoleWithHttpInfoAsync

public CompletableFuture<ApiResponse<UsersResponse>> addUserToRoleWithHttpInfoAsync(String roleId,
 RelationshipToUser body)

Add a user to a role.

See addUserToRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToUser).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<UsersResponse>>

cloneRole

public RoleResponse cloneRole(String roleId,
 RoleCloneRequest body)
                       throws ApiException

Create a new role by cloning an existing role.

See cloneRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RoleCloneRequest).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

RoleResponse

Throws:

ApiException - if fails to make API call

cloneRoleAsync

public CompletableFuture<RoleResponse> cloneRoleAsync(String roleId,
 RoleCloneRequest body)

Create a new role by cloning an existing role.

See cloneRoleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RoleCloneRequest).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<RoleResponse>

cloneRoleWithHttpInfo

public ApiResponse<RoleResponse> cloneRoleWithHttpInfo(String roleId,
 RoleCloneRequest body)
                                                throws ApiException

Clone an existing role

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

ApiResponse<RoleResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
404	Not found	-
409	Conflict	-
429	Too many requests	-

cloneRoleWithHttpInfoAsync

public CompletableFuture<ApiResponse<RoleResponse>> cloneRoleWithHttpInfoAsync(String roleId,
 RoleCloneRequest body)

Create a new role by cloning an existing role.

See cloneRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RoleCloneRequest).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<RoleResponse>>

createRole

public RoleCreateResponse createRole(RoleCreateRequest body)
                              throws ApiException

Create role.

See createRoleWithHttpInfo(com.datadog.api.client.v2.model.RoleCreateRequest).

Parameters:

body - (required)

Returns:

RoleCreateResponse

Throws:

ApiException - if fails to make API call

createRoleAsync

public CompletableFuture<RoleCreateResponse> createRoleAsync(RoleCreateRequest body)

Create role.

See createRoleWithHttpInfoAsync(com.datadog.api.client.v2.model.RoleCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<RoleCreateResponse>

createRoleWithHttpInfo

public ApiResponse<RoleCreateResponse> createRoleWithHttpInfo(RoleCreateRequest body)
                                                       throws ApiException

Create a new role for your organization.

The following read permissions are automatically added to every new role, even if they are not included in the request:

• Dashboards Read
• Notebooks Read
• Monitors Read
• APM Read
• Vulnerability Management Read
• RUM Apps Read
• Incidents Read
• SLOs Read
• CI Visibility Read
• CD Visibility Read

Parameters:

body - (required)

Returns:

ApiResponse<RoleCreateResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
429	Too many requests	-

createRoleWithHttpInfoAsync

public CompletableFuture<ApiResponse<RoleCreateResponse>> createRoleWithHttpInfoAsync(RoleCreateRequest body)

Create role.

See createRoleWithHttpInfo(com.datadog.api.client.v2.model.RoleCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<RoleCreateResponse>>

deleteRole

public void deleteRole(String roleId)
                throws ApiException

Delete role.

See deleteRoleWithHttpInfo(java.lang.String).

Parameters:

roleId - The unique identifier of the role. (required)

Throws:

ApiException - if fails to make API call

deleteRoleAsync

public CompletableFuture<Void> deleteRoleAsync(String roleId)

Delete role.

See deleteRoleWithHttpInfoAsync(java.lang.String).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

CompletableFuture

deleteRoleWithHttpInfo

public ApiResponse<Void> deleteRoleWithHttpInfo(String roleId)
                                         throws ApiException

Disables a role.

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	OK	-
403	Authentication error	-
404	Not found	-
429	Too many requests	-

deleteRoleWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteRoleWithHttpInfoAsync(String roleId)

Delete role.

See deleteRoleWithHttpInfo(java.lang.String).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getRole

public RoleResponse getRole(String roleId)
                     throws ApiException

Get a role.

See getRoleWithHttpInfo(java.lang.String).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

RoleResponse

Throws:

ApiException - if fails to make API call

getRoleAsync

public CompletableFuture<RoleResponse> getRoleAsync(String roleId)

Get a role.

See getRoleWithHttpInfoAsync(java.lang.String).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

CompletableFuture<RoleResponse>

getRoleWithHttpInfo

public ApiResponse<RoleResponse> getRoleWithHttpInfo(String roleId)
                                              throws ApiException

Get a role in the organization specified by the role’s role_id.

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

ApiResponse<RoleResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Authentication error	-
404	Not found	-
429	Too many requests	-

getRoleWithHttpInfoAsync

public CompletableFuture<ApiResponse<RoleResponse>> getRoleWithHttpInfoAsync(String roleId)

Get a role.

See getRoleWithHttpInfo(java.lang.String).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

CompletableFuture<ApiResponse<RoleResponse>>

listPermissions

public PermissionsResponse listPermissions()
                                    throws ApiException

List permissions.

See listPermissionsWithHttpInfo(com.datadog.api.client.v2.api.RolesApi.ListPermissionsOptionalParameters).

Returns:

PermissionsResponse

Throws:

ApiException - if fails to make API call

listPermissionsAsync

public CompletableFuture<PermissionsResponse> listPermissionsAsync()

List permissions.

See listPermissionsWithHttpInfoAsync(com.datadog.api.client.v2.api.RolesApi.ListPermissionsOptionalParameters).

Returns:

CompletableFuture<PermissionsResponse>

listPermissions

public PermissionsResponse listPermissions(RolesApi.ListPermissionsOptionalParameters parameters)
                                    throws ApiException

List permissions.

See listPermissionsWithHttpInfo(com.datadog.api.client.v2.api.RolesApi.ListPermissionsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

PermissionsResponse

Throws:

ApiException - if fails to make API call

listPermissionsAsync

public CompletableFuture<PermissionsResponse> listPermissionsAsync(RolesApi.ListPermissionsOptionalParameters parameters)

List permissions.

See listPermissionsWithHttpInfoAsync(com.datadog.api.client.v2.api.RolesApi.ListPermissionsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<PermissionsResponse>

listPermissionsWithHttpInfo

public ApiResponse<PermissionsResponse> listPermissionsWithHttpInfo(RolesApi.ListPermissionsOptionalParameters parameters)
                                                             throws ApiException

Returns a list of all permissions, including name, description, and ID.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<PermissionsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
429	Too many requests	-

listPermissionsWithHttpInfoAsync

public CompletableFuture<ApiResponse<PermissionsResponse>> listPermissionsWithHttpInfoAsync(RolesApi.ListPermissionsOptionalParameters parameters)

List permissions.

See listPermissionsWithHttpInfo(com.datadog.api.client.v2.api.RolesApi.ListPermissionsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<PermissionsResponse>>

listRolePermissions

public PermissionsResponse listRolePermissions(String roleId)
                                        throws ApiException

List permissions for a role.

See listRolePermissionsWithHttpInfo(java.lang.String).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

PermissionsResponse

Throws:

ApiException - if fails to make API call

listRolePermissionsAsync

public CompletableFuture<PermissionsResponse> listRolePermissionsAsync(String roleId)

List permissions for a role.

See listRolePermissionsWithHttpInfoAsync(java.lang.String).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

CompletableFuture<PermissionsResponse>

listRolePermissionsWithHttpInfo

public ApiResponse<PermissionsResponse> listRolePermissionsWithHttpInfo(String roleId)
                                                                 throws ApiException

Returns a list of all permissions for a single role.

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

ApiResponse<PermissionsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Authentication error	-
404	Not found	-
429	Too many requests	-

listRolePermissionsWithHttpInfoAsync

public CompletableFuture<ApiResponse<PermissionsResponse>> listRolePermissionsWithHttpInfoAsync(String roleId)

List permissions for a role.

See listRolePermissionsWithHttpInfo(java.lang.String).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

CompletableFuture<ApiResponse<PermissionsResponse>>

listRoles

public RolesResponse listRoles()
                        throws ApiException

List roles.

See listRolesWithHttpInfo(com.datadog.api.client.v2.api.RolesApi.ListRolesOptionalParameters).

Returns:

RolesResponse

Throws:

ApiException - if fails to make API call

listRolesAsync

public CompletableFuture<RolesResponse> listRolesAsync()

List roles.

See listRolesWithHttpInfoAsync(com.datadog.api.client.v2.api.RolesApi.ListRolesOptionalParameters).

Returns:

CompletableFuture<RolesResponse>

listRoles

public RolesResponse listRoles(RolesApi.ListRolesOptionalParameters parameters)
                        throws ApiException

List roles.

See listRolesWithHttpInfo(com.datadog.api.client.v2.api.RolesApi.ListRolesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

RolesResponse

Throws:

ApiException - if fails to make API call

listRolesAsync

public CompletableFuture<RolesResponse> listRolesAsync(RolesApi.ListRolesOptionalParameters parameters)

List roles.

See listRolesWithHttpInfoAsync(com.datadog.api.client.v2.api.RolesApi.ListRolesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<RolesResponse>

listRolesWithHttpInfo

public ApiResponse<RolesResponse> listRolesWithHttpInfo(RolesApi.ListRolesOptionalParameters parameters)
                                                 throws ApiException

Returns all roles, including their names and their unique identifiers.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<RolesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Authentication error	-
429	Too many requests	-

listRolesWithHttpInfoAsync

public CompletableFuture<ApiResponse<RolesResponse>> listRolesWithHttpInfoAsync(RolesApi.ListRolesOptionalParameters parameters)

List roles.

See listRolesWithHttpInfo(com.datadog.api.client.v2.api.RolesApi.ListRolesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<RolesResponse>>

listRoleTemplates

public RoleTemplateArray listRoleTemplates()
                                    throws ApiException

List role templates.

See listRoleTemplatesWithHttpInfo().

Returns:

RoleTemplateArray

Throws:

ApiException - if fails to make API call

listRoleTemplatesAsync

public CompletableFuture<RoleTemplateArray> listRoleTemplatesAsync()

List role templates.

See listRoleTemplatesWithHttpInfoAsync().

Returns:

CompletableFuture<RoleTemplateArray>

listRoleTemplatesWithHttpInfo

public ApiResponse<RoleTemplateArray> listRoleTemplatesWithHttpInfo()
                                                             throws ApiException

List all role templates

Returns:

ApiResponse<RoleTemplateArray>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
429	Too many requests	-

listRoleTemplatesWithHttpInfoAsync

public CompletableFuture<ApiResponse<RoleTemplateArray>> listRoleTemplatesWithHttpInfoAsync()

List role templates.

See listRoleTemplatesWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<RoleTemplateArray>>

listRoleUsers

public UsersResponse listRoleUsers(String roleId)
                            throws ApiException

Get all users of a role.

See listRoleUsersWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.RolesApi.ListRoleUsersOptionalParameters).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

UsersResponse

Throws:

ApiException - if fails to make API call

listRoleUsersAsync

public CompletableFuture<UsersResponse> listRoleUsersAsync(String roleId)

Get all users of a role.

See listRoleUsersWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.RolesApi.ListRoleUsersOptionalParameters).

Parameters:

roleId - The unique identifier of the role. (required)

Returns:

CompletableFuture<UsersResponse>

listRoleUsers

public UsersResponse listRoleUsers(String roleId,
 RolesApi.ListRoleUsersOptionalParameters parameters)
                            throws ApiException

Get all users of a role.

See listRoleUsersWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.RolesApi.ListRoleUsersOptionalParameters).

Parameters:

roleId - The unique identifier of the role. (required)

parameters - Optional parameters for the request.

Returns:

UsersResponse

Throws:

ApiException - if fails to make API call

listRoleUsersAsync

public CompletableFuture<UsersResponse> listRoleUsersAsync(String roleId,
 RolesApi.ListRoleUsersOptionalParameters parameters)

Get all users of a role.

See listRoleUsersWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.RolesApi.ListRoleUsersOptionalParameters).

Parameters:

roleId - The unique identifier of the role. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<UsersResponse>

listRoleUsersWithHttpInfo

public ApiResponse<UsersResponse> listRoleUsersWithHttpInfo(String roleId,
 RolesApi.ListRoleUsersOptionalParameters parameters)
                                                     throws ApiException

Gets all users of a role.

Parameters:

roleId - The unique identifier of the role. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<UsersResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Authentication error	-
404	Not found	-
429	Too many requests	-

listRoleUsersWithHttpInfoAsync

public CompletableFuture<ApiResponse<UsersResponse>> listRoleUsersWithHttpInfoAsync(String roleId,
 RolesApi.ListRoleUsersOptionalParameters parameters)

Get all users of a role.

See listRoleUsersWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.RolesApi.ListRoleUsersOptionalParameters).

Parameters:

roleId - The unique identifier of the role. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<UsersResponse>>

removePermissionFromRole

public PermissionsResponse removePermissionFromRole(String roleId,
 RelationshipToPermission body)
                                             throws ApiException

Revoke permission.

See removePermissionFromRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToPermission).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

PermissionsResponse

Throws:

ApiException - if fails to make API call

removePermissionFromRoleAsync

public CompletableFuture<PermissionsResponse> removePermissionFromRoleAsync(String roleId,
 RelationshipToPermission body)

Revoke permission.

See removePermissionFromRoleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RelationshipToPermission).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<PermissionsResponse>

removePermissionFromRoleWithHttpInfo

public ApiResponse<PermissionsResponse> removePermissionFromRoleWithHttpInfo(String roleId,
 RelationshipToPermission body)
                                                                      throws ApiException

Removes a permission from a role.

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

ApiResponse<PermissionsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
404	Not found	-
429	Too many requests	-

removePermissionFromRoleWithHttpInfoAsync

public CompletableFuture<ApiResponse<PermissionsResponse>> removePermissionFromRoleWithHttpInfoAsync(String roleId,
 RelationshipToPermission body)

Revoke permission.

See removePermissionFromRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToPermission).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<PermissionsResponse>>

removeUserFromRole

public UsersResponse removeUserFromRole(String roleId,
 RelationshipToUser body)
                                 throws ApiException

Remove a user from a role.

See removeUserFromRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToUser).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

UsersResponse

Throws:

ApiException - if fails to make API call

removeUserFromRoleAsync

public CompletableFuture<UsersResponse> removeUserFromRoleAsync(String roleId,
 RelationshipToUser body)

Remove a user from a role.

See removeUserFromRoleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RelationshipToUser).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<UsersResponse>

removeUserFromRoleWithHttpInfo

public ApiResponse<UsersResponse> removeUserFromRoleWithHttpInfo(String roleId,
 RelationshipToUser body)
                                                          throws ApiException

Removes a user from a role.

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

ApiResponse<UsersResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
404	Not found	-
429	Too many requests	-

removeUserFromRoleWithHttpInfoAsync

public CompletableFuture<ApiResponse<UsersResponse>> removeUserFromRoleWithHttpInfoAsync(String roleId,
 RelationshipToUser body)

Remove a user from a role.

See removeUserFromRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToUser).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<UsersResponse>>

updateRole

public RoleUpdateResponse updateRole(String roleId,
 RoleUpdateRequest body)
                              throws ApiException

Update a role.

See updateRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RoleUpdateRequest).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

RoleUpdateResponse

Throws:

ApiException - if fails to make API call

updateRoleAsync

public CompletableFuture<RoleUpdateResponse> updateRoleAsync(String roleId,
 RoleUpdateRequest body)

Update a role.

See updateRoleWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RoleUpdateRequest).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<RoleUpdateResponse>

updateRoleWithHttpInfo

public ApiResponse<RoleUpdateResponse> updateRoleWithHttpInfo(String roleId,
 RoleUpdateRequest body)
                                                       throws ApiException

Edit a role. Can only be used with application keys belonging to administrators.

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

ApiResponse<RoleUpdateResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication error	-
404	Not found	-
422	Unprocessable Entity	-
429	Too many requests	-

updateRoleWithHttpInfoAsync

public CompletableFuture<ApiResponse<RoleUpdateResponse>> updateRoleWithHttpInfoAsync(String roleId,
 RoleUpdateRequest body)

Update a role.

See updateRoleWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RoleUpdateRequest).

Parameters:

roleId - The unique identifier of the role. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<RoleUpdateResponse>>