Class ClientGrants

Index

Constructors

constructor

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

Methods

list

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.clientGrants.list("id")
```

create

create(
    id: string,
    request: Management.AssociateOrganizationClientGrantRequestContent,
    requestOptions?: ClientGrants.RequestOptions,
): HttpResponsePromise<AssociateOrganizationClientGrantResponseContent>
Parameters
- id: string
  Organization identifier.
- request: Management.AssociateOrganizationClientGrantRequestContent
- OptionalrequestOptions: ClientGrants.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,
    grantId: string,
    requestOptions?: ClientGrants.RequestOptions,
): HttpResponsePromise<void>
Parameters
- id: string
  Organization identifier.
- grantId: string
  The Client Grant ID to remove from the organization
- OptionalrequestOptions: ClientGrants.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")
```

`Protected`_getAuthorizationHeader

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

Properties

`Protected` `Readonly`_options

_options: ClientGrants.Options

Class ClientGrants

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns ClientGrants

Methods

list

Parameters

Returns Promise<Page<OrganizationClientGrant>>

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

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options