Class UserGrantsClient

Index

Constructors

Methods

list deleteByUserId delete

Properties

Constructors

constructor

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

Methods

list

list(
request?: ListUserGrantsRequestParameters,
requestOptions?: UserGrantsClient.RequestOptions,
): Promise<Page<UserGrant, ListUserGrantsOffsetPaginatedResponseContent>>
Retrieve the grants associated with your account.
Parameters
- request: ListUserGrantsRequestParameters = {}
- OptionalrequestOptions: UserGrantsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<UserGrant, ListUserGrantsOffsetPaginatedResponseContent>>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userGrants.list({
        per_page: 1,
        page: 1,
        include_totals: true,
        user_id: "user_id",
        client_id: "client_id",
        audience: "audience"
    })
```

deleteByUserId

deleteByUserId(
request: DeleteUserGrantByUserIdRequestParameters,
requestOptions?: UserGrantsClient.RequestOptions,
): HttpResponsePromise<void>
Delete a grant associated with your account.
Parameters
- request: DeleteUserGrantByUserIdRequestParameters
- OptionalrequestOptions: UserGrantsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userGrants.deleteByUserId({
        user_id: "user_id"
    })
```

delete

delete(
id: string,
requestOptions?: UserGrantsClient.RequestOptions,
): HttpResponsePromise<void>
Delete a grant associated with your account.
Parameters
- id: string
  ID of the grant to delete.
- OptionalrequestOptions: UserGrantsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.userGrants.delete("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>