Constructor Detail

Method Detail

• withRawResponse

   abstract UserServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract UserServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• retrieve

   CompletableFuture<ApiResponseOfUser> retrieve(String userId)

  Retrieves detailed information about a specific user in an organization or profile. Requires developer role or higher.

• retrieve

   CompletableFuture<ApiResponseOfUser> retrieve(String userId, UserRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<ApiResponseOfUser> retrieve(String userId, UserRetrieveParams params)

• retrieve

   abstract CompletableFuture<ApiResponseOfUser> retrieve(UserRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<ApiResponseOfUser> retrieve(UserRetrieveParams params)

• retrieve

   CompletableFuture<ApiResponseOfUser> retrieve(String userId, RequestOptions requestOptions)

• list

   CompletableFuture<UserListResponse> list()

  Retrieves all users who have access to the organization or profile identified by the API key, including their roles and status. Shows invited users (pending acceptance) and active users. Requires developer role or higher.

• list

   abstract CompletableFuture<UserListResponse> list(UserListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<UserListResponse> list(UserListParams params)

• list

   CompletableFuture<UserListResponse> list(RequestOptions requestOptions)

• invite

   CompletableFuture<ApiResponseOfUser> invite()

  Sends an invitation to a user to join the organization or profile with a specific role. Requires admin role. The user will receive an invitation email with a token to accept. Invitation tokens expire after 7 days.

• invite

   abstract CompletableFuture<ApiResponseOfUser> invite(UserInviteParams params, RequestOptions requestOptions)

• invite

   CompletableFuture<ApiResponseOfUser> invite(UserInviteParams params)

• invite

   CompletableFuture<ApiResponseOfUser> invite(RequestOptions requestOptions)

• remove

   CompletableFuture<Void> remove(String userId)

  Removes a user's access to an organization or profile. Requires admin role. You cannot remove yourself or remove the last admin.

• remove

   CompletableFuture<Void> remove(String userId, UserRemoveParams params, RequestOptions requestOptions)

• remove

   CompletableFuture<Void> remove(String userId, UserRemoveParams params)

• remove

   abstract CompletableFuture<Void> remove(UserRemoveParams params, RequestOptions requestOptions)

• remove

   CompletableFuture<Void> remove(UserRemoveParams params)

• remove

   CompletableFuture<Void> remove(String userId, RequestOptions requestOptions)

• updateRole

   CompletableFuture<ApiResponseOfUser> updateRole(String userId)

  Updates a user's role in the organization or profile. Requires admin role. You cannot change your own role or demote the last admin.

• updateRole

   CompletableFuture<ApiResponseOfUser> updateRole(String userId, UserUpdateRoleParams params, RequestOptions requestOptions)

• updateRole

   CompletableFuture<ApiResponseOfUser> updateRole(String userId, UserUpdateRoleParams params)

• updateRole

   abstract CompletableFuture<ApiResponseOfUser> updateRole(UserUpdateRoleParams params, RequestOptions requestOptions)

• updateRole

   CompletableFuture<ApiResponseOfUser> updateRole(UserUpdateRoleParams params)

• updateRole

   CompletableFuture<ApiResponseOfUser> updateRole(String userId, RequestOptions requestOptions)