com.datadog.api.client.v2.api

Class UsersApi

java.lang.Object

com.datadog.api.client.v2.api.UsersApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsersApi.ListUsersOptionalParameters Manage optional parameters to listUsers.

Constructor Summary

Constructors

Constructor and Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UserResponse	createUser(UserCreateRequest body) Create a user.
CompletableFuture<UserResponse>	createUserAsync(UserCreateRequest body) Create a user.
ApiResponse<UserResponse>	createUserWithHttpInfo(UserCreateRequest body) Create a user for your organization.
CompletableFuture<ApiResponse<UserResponse>>	createUserWithHttpInfoAsync(UserCreateRequest body) Create a user.
void	disableUser(String userId) Disable a user.
CompletableFuture<Void>	disableUserAsync(String userId) Disable a user.
ApiResponse<Void>	disableUserWithHttpInfo(String userId) Disable a user.
CompletableFuture<ApiResponse<Void>>	disableUserWithHttpInfoAsync(String userId) Disable a user.
ApiClient	getApiClient() Get the API client.
UserInvitationResponse	getInvitation(String userInvitationUuid) Get a user invitation.
CompletableFuture<UserInvitationResponse>	getInvitationAsync(String userInvitationUuid) Get a user invitation.
ApiResponse<UserInvitationResponse>	getInvitationWithHttpInfo(String userInvitationUuid) Returns a single user invitation by its UUID.
CompletableFuture<ApiResponse<UserInvitationResponse>>	getInvitationWithHttpInfoAsync(String userInvitationUuid) Get a user invitation.
UserResponse	getUser(String userId) Get user details.
CompletableFuture<UserResponse>	getUserAsync(String userId) Get user details.
ApiResponse<UserResponse>	getUserWithHttpInfo(String userId) Get a user in the organization specified by the user’s user_id.
CompletableFuture<ApiResponse<UserResponse>>	getUserWithHttpInfoAsync(String userId) Get user details.
UserResponse	listUserOrganizations(String userId) Get a user organization.
CompletableFuture<UserResponse>	listUserOrganizationsAsync(String userId) Get a user organization.
ApiResponse<UserResponse>	listUserOrganizationsWithHttpInfo(String userId) Get a user organization.
CompletableFuture<ApiResponse<UserResponse>>	listUserOrganizationsWithHttpInfoAsync(String userId) Get a user organization.
PermissionsResponse	listUserPermissions(String userId) Get a user permissions.
CompletableFuture<PermissionsResponse>	listUserPermissionsAsync(String userId) Get a user permissions.
ApiResponse<PermissionsResponse>	listUserPermissionsWithHttpInfo(String userId) Get a user permission set.
CompletableFuture<ApiResponse<PermissionsResponse>>	listUserPermissionsWithHttpInfoAsync(String userId) Get a user permissions.
UsersResponse	listUsers() List all users.
UsersResponse	listUsers(UsersApi.ListUsersOptionalParameters parameters) List all users.
CompletableFuture<UsersResponse>	listUsersAsync() List all users.
CompletableFuture<UsersResponse>	listUsersAsync(UsersApi.ListUsersOptionalParameters parameters) List all users.
ApiResponse<UsersResponse>	listUsersWithHttpInfo(UsersApi.ListUsersOptionalParameters parameters) Get the list of all users in the organization.
CompletableFuture<ApiResponse<UsersResponse>>	listUsersWithHttpInfoAsync(UsersApi.ListUsersOptionalParameters parameters) List all users.
PaginationIterable<User>	listUsersWithPagination() List all users.
PaginationIterable<User>	listUsersWithPagination(UsersApi.ListUsersOptionalParameters parameters) List all users.
UserInvitationsResponse	sendInvitations(UserInvitationsRequest body) Send invitation emails.
CompletableFuture<UserInvitationsResponse>	sendInvitationsAsync(UserInvitationsRequest body) Send invitation emails.
ApiResponse<UserInvitationsResponse>	sendInvitationsWithHttpInfo(UserInvitationsRequest body) Sends emails to one or more users inviting them to join the organization.
CompletableFuture<ApiResponse<UserInvitationsResponse>>	sendInvitationsWithHttpInfoAsync(UserInvitationsRequest body) Send invitation emails.
void	setApiClient(ApiClient apiClient) Set the API client.
UserResponse	updateUser(String userId, UserUpdateRequest body) Update a user.
CompletableFuture<UserResponse>	updateUserAsync(String userId, UserUpdateRequest body) Update a user.
ApiResponse<UserResponse>	updateUserWithHttpInfo(String userId, UserUpdateRequest body) Edit a user.
CompletableFuture<ApiResponse<UserResponse>>	updateUserWithHttpInfoAsync(String userId, UserUpdateRequest body) Update a user.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersApi

public UsersApi()

UsersApi

public UsersApi(ApiClient apiClient)

Method Detail

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

createUser

public UserResponse createUser(UserCreateRequest body)
                        throws ApiException

Create a user.

See createUserWithHttpInfo(com.datadog.api.client.v2.model.UserCreateRequest).

Parameters:

body - (required)

Returns:

UserResponse

Throws:

ApiException - if fails to make API call

createUserAsync

public CompletableFuture<UserResponse> createUserAsync(UserCreateRequest body)

Create a user.

See createUserWithHttpInfoAsync(com.datadog.api.client.v2.model.UserCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<UserResponse>

createUserWithHttpInfo

public ApiResponse<UserResponse> createUserWithHttpInfo(UserCreateRequest body)
                                                 throws ApiException

Create a user for your organization.

Parameters:

body - (required)

Returns:

ApiResponse<UserResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

createUserWithHttpInfoAsync

public CompletableFuture<ApiResponse<UserResponse>> createUserWithHttpInfoAsync(UserCreateRequest body)

Create a user.

See createUserWithHttpInfo(com.datadog.api.client.v2.model.UserCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<UserResponse>>

disableUser

public void disableUser(String userId)
                 throws ApiException

Disable a user.

See disableUserWithHttpInfo(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Throws:

ApiException - if fails to make API call

disableUserAsync

public CompletableFuture<Void> disableUserAsync(String userId)

Disable a user.

See disableUserWithHttpInfoAsync(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

CompletableFuture

disableUserWithHttpInfo

public ApiResponse<Void> disableUserWithHttpInfo(String userId)
                                          throws ApiException

Disable a user. Can only be used with an application key belonging to an administrator user.

Parameters:

userId - The ID of the user. (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	-

disableUserWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> disableUserWithHttpInfoAsync(String userId)

Disable a user.

See disableUserWithHttpInfo(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getInvitation

public UserInvitationResponse getInvitation(String userInvitationUuid)
                                     throws ApiException

Get a user invitation.

See getInvitationWithHttpInfo(java.lang.String).

Parameters:

userInvitationUuid - The UUID of the user invitation. (required)

Returns:

UserInvitationResponse

Throws:

ApiException - if fails to make API call

getInvitationAsync

public CompletableFuture<UserInvitationResponse> getInvitationAsync(String userInvitationUuid)

Get a user invitation.

See getInvitationWithHttpInfoAsync(java.lang.String).

Parameters:

userInvitationUuid - The UUID of the user invitation. (required)

Returns:

CompletableFuture<UserInvitationResponse>

getInvitationWithHttpInfo

public ApiResponse<UserInvitationResponse> getInvitationWithHttpInfo(String userInvitationUuid)
                                                              throws ApiException

Returns a single user invitation by its UUID.

Parameters:

userInvitationUuid - The UUID of the user invitation. (required)

Returns:

ApiResponse<UserInvitationResponse>

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	-

getInvitationWithHttpInfoAsync

public CompletableFuture<ApiResponse<UserInvitationResponse>> getInvitationWithHttpInfoAsync(String userInvitationUuid)

Get a user invitation.

See getInvitationWithHttpInfo(java.lang.String).

Parameters:

userInvitationUuid - The UUID of the user invitation. (required)

Returns:

CompletableFuture<ApiResponse<UserInvitationResponse>>

getUser

public UserResponse getUser(String userId)
                     throws ApiException

Get user details.

See getUserWithHttpInfo(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

UserResponse

Throws:

ApiException - if fails to make API call

getUserAsync

public CompletableFuture<UserResponse> getUserAsync(String userId)

Get user details.

See getUserWithHttpInfoAsync(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

CompletableFuture<UserResponse>

getUserWithHttpInfo

public ApiResponse<UserResponse> getUserWithHttpInfo(String userId)
                                              throws ApiException

Get a user in the organization specified by the user’s user_id.

Parameters:

userId - The ID of the user. (required)

Returns:

ApiResponse<UserResponse>

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	-

getUserWithHttpInfoAsync

public CompletableFuture<ApiResponse<UserResponse>> getUserWithHttpInfoAsync(String userId)

Get user details.

See getUserWithHttpInfo(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

CompletableFuture<ApiResponse<UserResponse>>

listUserOrganizations

public UserResponse listUserOrganizations(String userId)
                                   throws ApiException

Get a user organization.

See listUserOrganizationsWithHttpInfo(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

UserResponse

Throws:

ApiException - if fails to make API call

listUserOrganizationsAsync

public CompletableFuture<UserResponse> listUserOrganizationsAsync(String userId)

Get a user organization.

See listUserOrganizationsWithHttpInfoAsync(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

CompletableFuture<UserResponse>

listUserOrganizationsWithHttpInfo

public ApiResponse<UserResponse> listUserOrganizationsWithHttpInfo(String userId)
                                                            throws ApiException

Get a user organization. Returns the user information and all organizations joined by this user.

Parameters:

userId - The ID of the user. (required)

Returns:

ApiResponse<UserResponse>

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	-

listUserOrganizationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<UserResponse>> listUserOrganizationsWithHttpInfoAsync(String userId)

Get a user organization.

See listUserOrganizationsWithHttpInfo(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

CompletableFuture<ApiResponse<UserResponse>>

listUserPermissions

public PermissionsResponse listUserPermissions(String userId)
                                        throws ApiException

Get a user permissions.

See listUserPermissionsWithHttpInfo(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

PermissionsResponse

Throws:

ApiException - if fails to make API call

listUserPermissionsAsync

public CompletableFuture<PermissionsResponse> listUserPermissionsAsync(String userId)

Get a user permissions.

See listUserPermissionsWithHttpInfoAsync(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

CompletableFuture<PermissionsResponse>

listUserPermissionsWithHttpInfo

public ApiResponse<PermissionsResponse> listUserPermissionsWithHttpInfo(String userId)
                                                                 throws ApiException

Get a user permission set. Returns a list of the user’s permissions granted by the associated user's roles.

Parameters:

userId - The ID of the user. (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	-

listUserPermissionsWithHttpInfoAsync

public CompletableFuture<ApiResponse<PermissionsResponse>> listUserPermissionsWithHttpInfoAsync(String userId)

Get a user permissions.

See listUserPermissionsWithHttpInfo(java.lang.String).

Parameters:

userId - The ID of the user. (required)

Returns:

CompletableFuture<ApiResponse<PermissionsResponse>>

listUsers

public UsersResponse listUsers()
                        throws ApiException

List all users.

See listUsersWithHttpInfo(com.datadog.api.client.v2.api.UsersApi.ListUsersOptionalParameters).

Returns:

UsersResponse

Throws:

ApiException - if fails to make API call

listUsersAsync

public CompletableFuture<UsersResponse> listUsersAsync()

List all users.

See listUsersWithHttpInfoAsync(com.datadog.api.client.v2.api.UsersApi.ListUsersOptionalParameters).

Returns:

CompletableFuture<UsersResponse>

listUsers

public UsersResponse listUsers(UsersApi.ListUsersOptionalParameters parameters)
                        throws ApiException

List all users.

See listUsersWithHttpInfo(com.datadog.api.client.v2.api.UsersApi.ListUsersOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

UsersResponse

Throws:

ApiException - if fails to make API call

listUsersAsync

public CompletableFuture<UsersResponse> listUsersAsync(UsersApi.ListUsersOptionalParameters parameters)

List all users.

See listUsersWithHttpInfoAsync(com.datadog.api.client.v2.api.UsersApi.ListUsersOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<UsersResponse>

listUsersWithPagination

public PaginationIterable<User> listUsersWithPagination()

List all users.

See listUsersWithHttpInfo(com.datadog.api.client.v2.api.UsersApi.ListUsersOptionalParameters).

Returns:

PaginationIterable<User>

listUsersWithPagination

public PaginationIterable<User> listUsersWithPagination(UsersApi.ListUsersOptionalParameters parameters)

List all users.

See listUsersWithHttpInfo(com.datadog.api.client.v2.api.UsersApi.ListUsersOptionalParameters).

Returns:

UsersResponse

listUsersWithHttpInfo

public ApiResponse<UsersResponse> listUsersWithHttpInfo(UsersApi.ListUsersOptionalParameters parameters)
                                                 throws ApiException

Get the list of all users in the organization. This list includes all users even if they are deactivated or unverified.

Parameters:

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	-
400	Bad Request	-
403	Authentication error	-
429	Too many requests	-

listUsersWithHttpInfoAsync

public CompletableFuture<ApiResponse<UsersResponse>> listUsersWithHttpInfoAsync(UsersApi.ListUsersOptionalParameters parameters)

List all users.

See listUsersWithHttpInfo(com.datadog.api.client.v2.api.UsersApi.ListUsersOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<UsersResponse>>

sendInvitations

public UserInvitationsResponse sendInvitations(UserInvitationsRequest body)
                                        throws ApiException

Send invitation emails.

See sendInvitationsWithHttpInfo(com.datadog.api.client.v2.model.UserInvitationsRequest).

Parameters:

body - (required)

Returns:

UserInvitationsResponse

Throws:

ApiException - if fails to make API call

sendInvitationsAsync

public CompletableFuture<UserInvitationsResponse> sendInvitationsAsync(UserInvitationsRequest body)

Send invitation emails.

See sendInvitationsWithHttpInfoAsync(com.datadog.api.client.v2.model.UserInvitationsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<UserInvitationsResponse>

sendInvitationsWithHttpInfo

public ApiResponse<UserInvitationsResponse> sendInvitationsWithHttpInfo(UserInvitationsRequest body)
                                                                 throws ApiException

Sends emails to one or more users inviting them to join the organization.

Parameters:

body - (required)

Returns:

ApiResponse<UserInvitationsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

sendInvitationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<UserInvitationsResponse>> sendInvitationsWithHttpInfoAsync(UserInvitationsRequest body)

Send invitation emails.

See sendInvitationsWithHttpInfo(com.datadog.api.client.v2.model.UserInvitationsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<UserInvitationsResponse>>

updateUser

public UserResponse updateUser(String userId,
                               UserUpdateRequest body)
                        throws ApiException

Update a user.

See updateUserWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UserUpdateRequest).

Parameters:

userId - The ID of the user. (required)

body - (required)

Returns:

UserResponse

Throws:

ApiException - if fails to make API call

updateUserAsync

public CompletableFuture<UserResponse> updateUserAsync(String userId,
                                                       UserUpdateRequest body)

Update a user.

See updateUserWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.UserUpdateRequest).

Parameters:

userId - The ID of the user. (required)

body - (required)

Returns:

CompletableFuture<UserResponse>

updateUserWithHttpInfo

public ApiResponse<UserResponse> updateUserWithHttpInfo(String userId,
                                                        UserUpdateRequest body)
                                                 throws ApiException

Edit a user. Can only be used with an application key belonging to an administrator user.

Parameters:

userId - The ID of the user. (required)

body - (required)

Returns:

ApiResponse<UserResponse>

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	-

updateUserWithHttpInfoAsync

public CompletableFuture<ApiResponse<UserResponse>> updateUserWithHttpInfoAsync(String userId,
                                                                                UserUpdateRequest body)

Update a user.

See updateUserWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.UserUpdateRequest).

Parameters:

userId - The ID of the user. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<UserResponse>>