docs/classes/management.SDK.UsersClient-1.html
new UsersClient(options: BaseClientOptions): UsersClient
list(
id: string,
request?: ListRoleUsersRequestParameters,
requestOptions?: UsersClient.RequestOptions,
): Promise<Page<RoleUser, ListRoleUsersPaginatedResponseContent>>
Retrieve list of users associated with a specific role. For Dashboard instructions, review View Users Assigned to Roles.
This endpoint supports two types of pagination:
Checkpoint pagination must be used if you need to retrieve more than 1000 organization members.
To search by checkpoint, use the following parameters:
from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.Note : The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
ID of the role to retrieve a list of users associated with.
OptionalrequestOptions: UsersClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.roles.users.list("id", { from: "from", take: 1 })Copy
assign(
id: string,
request: AssignRoleUsersRequestContent,
requestOptions?: UsersClient.RequestOptions,
): HttpResponsePromise<void>
Assign one or more users to an existing user role. To learn more, review Role-Based Access Control.
Note : New roles cannot be created through this action.
ID of the role to assign users to.
OptionalrequestOptions: UsersClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.roles.users.assign("id", { users: ["users"] })Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listassign Properties _options