docs/classes/management.SDK.PermissionsClient.html
new PermissionsClient(options: BaseClientOptions): PermissionsClient
list(
id: string,
request?: ListRolePermissionsRequestParameters,
requestOptions?: PermissionsClient.RequestOptions,
): Promise<
Page<
PermissionsResponsePayload,
ListRolePermissionsOffsetPaginatedResponseContent,
>,
>
Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.
ID of the role to list granted permissions.
OptionalrequestOptions: PermissionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.roles.permissions.list("id", { per_page: 1, page: 1, include_totals: true })Copy
add(
id: string,
request: AddRolePermissionsRequestContent,
requestOptions?: PermissionsClient.RequestOptions,
): HttpResponsePromise<void>
Add one or more permissions to a specified user role.
ID of the role to add permissions to.
OptionalrequestOptions: PermissionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.roles.permissions.add("id", { permissions: [{ resource_server_identifier: "resource_server_identifier", permission_name: "permission_name" }] })Copy
delete(
id: string,
request: DeleteRolePermissionsRequestContent,
requestOptions?: PermissionsClient.RequestOptions,
): HttpResponsePromise<void>
Remove one or more permissions from a specified user role.
ID of the role to remove permissions from.
OptionalrequestOptions: PermissionsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.roles.permissions.delete("id", { permissions: [{ resource_server_identifier: "resource_server_identifier", permission_name: "permission_name" }] })Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listadddelete Properties _options