Class ClientGrantsClient

Index

Constructors

constructor

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

Methods

list

list(
    id: string,
    request?: ListOrganizationClientGrantsRequestParameters,
    requestOptions?: ClientGrantsClient.RequestOptions,
): Promise<
    Page<
        OrganizationClientGrant,
        ListOrganizationClientGrantsOffsetPaginatedResponseContent,
    >,
>
Parameters
- id: string
  Organization identifier.
- request: ListOrganizationClientGrantsRequestParameters = {}
- OptionalrequestOptions: ClientGrantsClient.RequestOptions
  Request-specific configuration.
Returns Promise<
    Page<
        OrganizationClientGrant,
        ListOrganizationClientGrantsOffsetPaginatedResponseContent,
    >,
>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

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

create

create(
    id: string,
    request: AssociateOrganizationClientGrantRequestContent,
    requestOptions?: ClientGrantsClient.RequestOptions,
): HttpResponsePromise<AssociateOrganizationClientGrantResponseContent>
Parameters
- id: string
  Organization identifier.
- request: AssociateOrganizationClientGrantRequestContent
- OptionalrequestOptions: ClientGrantsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<AssociateOrganizationClientGrantResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.clientGrants.create("id", {
        grant_id: "grant_id"
    })
```

delete

delete(
    id: string,
    grant_id: string,
    requestOptions?: ClientGrantsClient.RequestOptions,
): HttpResponsePromise<void>
Parameters
- id: string
  Organization identifier.
- grant_id: string
  The Client Grant ID to remove from the organization
- OptionalrequestOptions: ClientGrantsClient.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.organizations.clientGrants.delete("id", "grant_id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class ClientGrantsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns ClientGrantsClient

Methods

list

Parameters

Returns Promise< Page< OrganizationClientGrant, ListOrganizationClientGrantsOffsetPaginatedResponseContent, >,>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<AssociateOrganizationClientGrantResponseContent>

Throws

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<
OrganizationClientGrant,
ListOrganizationClientGrantsOffsetPaginatedResponseContent,
>,
>

`Protected` `Readonly`_options