com.datadog.api.client.v1.api

Class UsersApi

java.lang.Object

com.datadog.api.client.v1.api.UsersApi

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

Constructor Summary

Constructors

Constructor and Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UserResponse	createUser(User body) Create a user.
CompletableFuture<UserResponse>	createUserAsync(User body) Create a user.
ApiResponse<UserResponse>	createUserWithHttpInfo(User body) Create a user for your organization.
CompletableFuture<ApiResponse<UserResponse>>	createUserWithHttpInfoAsync(User body) Create a user.
UserDisableResponse	disableUser(String userHandle) Disable a user.
CompletableFuture<UserDisableResponse>	disableUserAsync(String userHandle) Disable a user.
ApiResponse<UserDisableResponse>	disableUserWithHttpInfo(String userHandle) Delete a user from an organization.
CompletableFuture<ApiResponse<UserDisableResponse>>	disableUserWithHttpInfoAsync(String userHandle) Disable a user.
ApiClient	getApiClient() Get the API client.
UserResponse	getUser(String userHandle) Get user details.
CompletableFuture<UserResponse>	getUserAsync(String userHandle) Get user details.
ApiResponse<UserResponse>	getUserWithHttpInfo(String userHandle) Get a user's details.
CompletableFuture<ApiResponse<UserResponse>>	getUserWithHttpInfoAsync(String userHandle) Get user details.
UserListResponse	listUsers() List all users.
CompletableFuture<UserListResponse>	listUsersAsync() List all users.
ApiResponse<UserListResponse>	listUsersWithHttpInfo() List all users for your organization.
CompletableFuture<ApiResponse<UserListResponse>>	listUsersWithHttpInfoAsync() List all users.
void	setApiClient(ApiClient apiClient) Set the API client.
UserResponse	updateUser(String userHandle, User body) Update a user.
CompletableFuture<UserResponse>	updateUserAsync(String userHandle, User body) Update a user.
ApiResponse<UserResponse>	updateUserWithHttpInfo(String userHandle, User body) Update a user information.
CompletableFuture<ApiResponse<UserResponse>>	updateUserWithHttpInfoAsync(String userHandle, User 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(User body)
                        throws ApiException

Create a user.

See createUserWithHttpInfo(com.datadog.api.client.v1.model.User).

Parameters:

body - User object that needs to be created. (required)

Returns:

UserResponse

Throws:

ApiException - if fails to make API call

createUserAsync

public CompletableFuture<UserResponse> createUserAsync(User body)

Create a user.

See createUserWithHttpInfoAsync(com.datadog.api.client.v1.model.User).

Parameters:

body - User object that needs to be created. (required)

Returns:

CompletableFuture<UserResponse>

createUserWithHttpInfo

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

Create a user for your organization.

Note: Users can only be created with the admin access role if application keys belong to administrators.

Parameters:

body - User object that needs to be created. (required)

Returns:

ApiResponse<UserResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	User created	-
400	Bad Request	-
403	Authentication error	-
409	Conflict	-
429	Too many requests	-

createUserWithHttpInfoAsync

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

Create a user.

See createUserWithHttpInfo(com.datadog.api.client.v1.model.User).

Parameters:

body - User object that needs to be created. (required)

Returns:

CompletableFuture<ApiResponse<UserResponse>>

disableUser

public UserDisableResponse disableUser(String userHandle)
                                throws ApiException

Disable a user.

See disableUserWithHttpInfo(java.lang.String).

Parameters:

userHandle - The handle of the user. (required)

Returns:

UserDisableResponse

Throws:

ApiException - if fails to make API call

disableUserAsync

public CompletableFuture<UserDisableResponse> disableUserAsync(String userHandle)

Disable a user.

See disableUserWithHttpInfoAsync(java.lang.String).

Parameters:

userHandle - The handle of the user. (required)

Returns:

CompletableFuture<UserDisableResponse>

disableUserWithHttpInfo

public ApiResponse<UserDisableResponse> disableUserWithHttpInfo(String userHandle)
                                                         throws ApiException

Delete a user from an organization.

Note: This endpoint can only be used with application keys belonging to administrators.

Parameters:

userHandle - The handle of the user. (required)

Returns:

ApiResponse<UserDisableResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	User disabled	-
400	Bad Request	-
403	Authentication error	-
404	Not Found	-
429	Too many requests	-

disableUserWithHttpInfoAsync

public CompletableFuture<ApiResponse<UserDisableResponse>> disableUserWithHttpInfoAsync(String userHandle)

Disable a user.

See disableUserWithHttpInfo(java.lang.String).

Parameters:

userHandle - The handle of the user. (required)

Returns:

CompletableFuture<ApiResponse<UserDisableResponse>>

getUser

public UserResponse getUser(String userHandle)
                     throws ApiException

Get user details.

See getUserWithHttpInfo(java.lang.String).

Parameters:

userHandle - The ID of the user. (required)

Returns:

UserResponse

Throws:

ApiException - if fails to make API call

getUserAsync

public CompletableFuture<UserResponse> getUserAsync(String userHandle)

Get user details.

See getUserWithHttpInfoAsync(java.lang.String).

Parameters:

userHandle - The ID of the user. (required)

Returns:

CompletableFuture<UserResponse>

getUserWithHttpInfo

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

Get a user's details.

Parameters:

userHandle - 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 for get user	-
403	Authentication error	-
404	Not Found	-
429	Too many requests	-

getUserWithHttpInfoAsync

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

Get user details.

See getUserWithHttpInfo(java.lang.String).

Parameters:

userHandle - The ID of the user. (required)

Returns:

CompletableFuture<ApiResponse<UserResponse>>

listUsers

public UserListResponse listUsers()
                           throws ApiException

List all users.

See listUsersWithHttpInfo().

Returns:

UserListResponse

Throws:

ApiException - if fails to make API call

listUsersAsync

public CompletableFuture<UserListResponse> listUsersAsync()

List all users.

See listUsersWithHttpInfoAsync().

Returns:

CompletableFuture<UserListResponse>

listUsersWithHttpInfo

public ApiResponse<UserListResponse> listUsersWithHttpInfo()
                                                    throws ApiException

List all users for your organization.

Returns:

ApiResponse<UserListResponse>

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	-

listUsersWithHttpInfoAsync

public CompletableFuture<ApiResponse<UserListResponse>> listUsersWithHttpInfoAsync()

List all users.

See listUsersWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<UserListResponse>>

updateUser

public UserResponse updateUser(String userHandle,
                               User body)
                        throws ApiException

Update a user.

See updateUserWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.User).

Parameters:

userHandle - The ID of the user. (required)

body - Description of the update. (required)

Returns:

UserResponse

Throws:

ApiException - if fails to make API call

updateUserAsync

public CompletableFuture<UserResponse> updateUserAsync(String userHandle,
                                                       User body)

Update a user.

See updateUserWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.User).

Parameters:

userHandle - The ID of the user. (required)

body - Description of the update. (required)

Returns:

CompletableFuture<UserResponse>

updateUserWithHttpInfo

public ApiResponse<UserResponse> updateUserWithHttpInfo(String userHandle,
                                                        User body)
                                                 throws ApiException

Update a user information.

Note: It can only be used with application keys belonging to administrators.

Parameters:

userHandle - The ID of the user. (required)

body - Description of the update. (required)

Returns:

ApiResponse<UserResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	User updated	-
400	Bad Request	-
403	Authentication error	-
404	Not Found	-
429	Too many requests	-

updateUserWithHttpInfoAsync

public CompletableFuture<ApiResponse<UserResponse>> updateUserWithHttpInfoAsync(String userHandle,
                                                                                User body)

Update a user.

See updateUserWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.User).

Parameters:

userHandle - The ID of the user. (required)

body - Description of the update. (required)

Returns:

CompletableFuture<ApiResponse<UserResponse>>