Class ClientGrants

Index

Accessors

organizations

get organizations(): Organizations
Returns Organizations

Constructors

constructor

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

Methods

list

list(
request?: Management.ListClientGrantsRequestParameters,
requestOptions?: ClientGrants.RequestOptions,
): Promise<Page<ClientGrantResponseContent>>
Retrieve a list of client grants, including the scopes associated with the application/API pair.
Parameters
- request: Management.ListClientGrantsRequestParameters = {}
- OptionalrequestOptions: ClientGrants.RequestOptions
  Request-specific configuration.
Returns Promise<Page<ClientGrantResponseContent>>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

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

create

create(
request: Management.CreateClientGrantRequestContent,
requestOptions?: ClientGrants.RequestOptions,
): HttpResponsePromise<CreateClientGrantResponseContent>
Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow.
Parameters
- request: Management.CreateClientGrantRequestContent
- OptionalrequestOptions: ClientGrants.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateClientGrantResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.clientGrants.create({
        client_id: "client_id",
        audience: "audience",
        scope: ["scope"]
    })
```

delete

delete(
id: string,
requestOptions?: ClientGrants.RequestOptions,
): HttpResponsePromise<void>
Delete the Client Credential Flow from your machine-to-machine application.
Parameters
- id: string
  ID of the client grant to delete.
- OptionalrequestOptions: ClientGrants.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

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

update

update(
    id: string,
    request?: Management.UpdateClientGrantRequestContent,
    requestOptions?: ClientGrants.RequestOptions,
): HttpResponsePromise<UpdateClientGrantResponseContent>
Update a client grant.
Parameters
- id: string
  ID of the client grant to update.
- request: Management.UpdateClientGrantRequestContent = {}
- OptionalrequestOptions: ClientGrants.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateClientGrantResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

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

`Protected`_getAuthorizationHeader

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

Properties

`Protected` `Readonly`_options

_options: ClientGrants.Options

`Protected`_organizations

_organizations: undefined | Organizations

Class ClientGrants

Index

Accessors

Constructors

Methods

Properties

Accessors

organizations

Returns Organizations

Constructors

constructor

Parameters

Returns ClientGrants

Methods

list

Parameters

Returns Promise<Page<ClientGrantResponseContent>>

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateClientGrantResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateClientGrantResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Protected_organizations

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options

`Protected`_organizations