• management
• SDK
• RolesClient

Class RolesClient

Index

Constructors

constructor

Methods

list

Properties

_options

Constructors

constructor

new RolesClient(options: BaseClientOptions): RolesClient

Parameters

• options: BaseClientOptions

Returns RolesClient

Methods

list

list(
id: string,
request: ListUserEffectivePermissionRoleSourceRequestParameters,
requestOptions?: RolesClient.RequestOptions,
): Promise<
Page<
UserEffectivePermissionRoleSourceResponseContent,
ListUserEffectivePermissionRoleSourcesResponseContent,
>,
>

Lists the roles which grant the user a given permission, including roles assigned directly to the user and those inherited through group memberships.

Parameters

• id: string

ID of the user to retrieve the permissions for.

• request: ListUserEffectivePermissionRoleSourceRequestParameters
• OptionalrequestOptions: RolesClient.RequestOptions

Request-specific configuration.

Returns Promise< Page< UserEffectivePermissionRoleSourceResponseContent, ListUserEffectivePermissionRoleSourcesResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.users.effectivePermissions.sources.roles.list("id", { from: "from", take: 1, resource_server_identifier: "resource_server_identifier", permission_name: "permission_name" })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods list Properties _options