Constructor Detail

Method Detail

• withRawResponse

   abstract UserService.WithRawResponse withRawResponse()

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

• withOptions

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

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

  The original service is not modified.

• retrieve

   ApiResponseOfUser retrieve(String userId)

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

• retrieve

   ApiResponseOfUser retrieve(String userId, UserRetrieveParams params, RequestOptions requestOptions)

• retrieve

   ApiResponseOfUser retrieve(String userId, UserRetrieveParams params)

• retrieve

   abstract ApiResponseOfUser retrieve(UserRetrieveParams params, RequestOptions requestOptions)

• retrieve

   ApiResponseOfUser retrieve(UserRetrieveParams params)

• retrieve

   ApiResponseOfUser retrieve(String userId, RequestOptions requestOptions)

• list

   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 UserListResponse list(UserListParams params, RequestOptions requestOptions)

• list

   UserListResponse list(UserListParams params)

• list

   UserListResponse list(RequestOptions requestOptions)

• invite

   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 ApiResponseOfUser invite(UserInviteParams params, RequestOptions requestOptions)

• invite

   ApiResponseOfUser invite(UserInviteParams params)

• invite

   ApiResponseOfUser invite(RequestOptions requestOptions)

• remove

   Unit 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

   Unit remove(String userId, UserRemoveParams params, RequestOptions requestOptions)

• remove

   Unit remove(String userId, UserRemoveParams params)

• remove

   abstract Unit remove(UserRemoveParams params, RequestOptions requestOptions)

• remove

   Unit remove(UserRemoveParams params)

• remove

   Unit remove(String userId, RequestOptions requestOptions)

• updateRole

   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

   ApiResponseOfUser updateRole(String userId, UserUpdateRoleParams params, RequestOptions requestOptions)

• updateRole

   ApiResponseOfUser updateRole(String userId, UserUpdateRoleParams params)

• updateRole

   abstract ApiResponseOfUser updateRole(UserUpdateRoleParams params, RequestOptions requestOptions)

• updateRole

   ApiResponseOfUser updateRole(UserUpdateRoleParams params)

• updateRole

   ApiResponseOfUser updateRole(String userId, RequestOptions requestOptions)