Class Permissions

Index

Constructors

constructor

new Permissions(_options: Permissions.Options): Permissions
Parameters
- _options: Permissions.Options
Returns Permissions

Methods

list

list(
    id: string,
    request?: Management.ListRolePermissionsRequestParameters,
    requestOptions?: Permissions.RequestOptions,
): Promise<Page<PermissionsResponsePayload>>
Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.
Parameters
- id: string
  ID of the role to list granted permissions.
- request: Management.ListRolePermissionsRequestParameters = {}
- OptionalrequestOptions: Permissions.RequestOptions
  Request-specific configuration.
Returns Promise<Page<PermissionsResponsePayload>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.roles.permissions.list("id")
```

add

add(
    id: string,
    request: Management.AddRolePermissionsRequestContent,
    requestOptions?: Permissions.RequestOptions,
): HttpResponsePromise<void>
Add one or more permissions to a specified user role.
Parameters
- id: string
  ID of the role to add permissions to.
- request: Management.AddRolePermissionsRequestContent
- OptionalrequestOptions: Permissions.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

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

delete

delete(
    id: string,
    request: Management.DeleteRolePermissionsRequestContent,
    requestOptions?: Permissions.RequestOptions,
): HttpResponsePromise<void>
Remove one or more permissions from a specified user role.
Parameters
- id: string
  ID of the role to remove permissions from.
- request: Management.DeleteRolePermissionsRequestContent
- OptionalrequestOptions: Permissions.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

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

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Permissions.Options

Class Permissions

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Permissions

Methods

list

Parameters

Returns Promise<Page<PermissionsResponsePayload>>

Throws

Throws

Throws

Throws

Throws

Example

add

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options