Class PermissionsClient

Index

Constructors

constructor

new PermissionsClient(options: BaseClientOptions): PermissionsClient
Parameters
- options: BaseClientOptions
Returns PermissionsClient

Methods

list

list(
    id: string,
    request?: ListUserPermissionsRequestParameters,
    requestOptions?: PermissionsClient.RequestOptions,
): Promise<
    Page<
        UserPermissionSchema,
        ListUserPermissionsOffsetPaginatedResponseContent,
    >,
>
Retrieve all permissions associated with the user.

Note: Returns only permissions from direct assignments and directly assigned roles. For permissions a user has via group-based role assignments, use GET /api/v2/users/{id}/effective-permissions.
Parameters
- id: string
  ID of the user to retrieve the permissions for.
- request: ListUserPermissionsRequestParameters = {}
- OptionalrequestOptions: PermissionsClient.RequestOptions
  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
    })
```

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: CreateUserPermissionsRequestContent
- OptionalrequestOptions: PermissionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.users.permissions.create("id", {
        permissions: [{
                resource_server_identifier: "resource_server_identifier",
                permission_name: "permission_name"
            }]
    })
```

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: DeleteUserPermissionsRequestContent
- OptionalrequestOptions: PermissionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.users.permissions.delete("id", {
        permissions: [{
                resource_server_identifier: "resource_server_identifier",
                permission_name: "permission_name"
            }]
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class PermissionsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns PermissionsClient

Methods

list

Parameters

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

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

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

`Protected` `Readonly`_options