Back to Node Auth0

Class PermissionsClient

docs/classes/management.SDK.PermissionsClient-1.html

5.9.16.0 KB
Original Source

Class PermissionsClient

Index

Constructors

constructor

Methods

listcreatedelete

Properties

_options

Constructors

constructor

new PermissionsClient(options: BaseClientOptions): PermissionsClient

Parameters

Returns PermissionsClient

Methods

list

list(
id: string,
request?: ListUserPermissionsRequestParameters,
requestOptions?: PermissionsClient.RequestOptions,
): Promise<
Page<
UserPermissionSchema,
ListUserPermissionsOffsetPaginatedResponseContent,
>,
>

Retrieve all permissions associated with the user.

Parameters

  • id: string

ID of the user to retrieve the permissions for.

Request-specific configuration.

Returns Promise< Page< UserPermissionSchema, ListUserPermissionsOffsetPaginatedResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.users.permissions.list("id", { per_page: 1, page: 1, include_totals: true })Copy

create

create(
id: string,
request: CreateUserPermissionsRequestContent,
requestOptions?: PermissionsClient.RequestOptions,
): HttpResponsePromise<void>

Assign permissions to a user.

Parameters

  • id: string

ID of the user to assign permissions to.

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.users.permissions.create("id", { permissions: [{ resource_server_identifier: "resource_server_identifier", permission_name: "permission_name" }] })Copy

delete

delete(
id: string,
request: DeleteUserPermissionsRequestContent,
requestOptions?: PermissionsClient.RequestOptions,
): HttpResponsePromise<void>

Remove permissions from a user.

Parameters

  • id: string

ID of the user to remove permissions from.

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.users.permissions.delete("id", { permissions: [{ 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 listcreatedelete Properties _options