Class ClientGrantsClient

Index

Accessors

organizations

get organizations(): OrganizationsClient

Returns OrganizationsClient

Constructors

constructor

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

Methods

list

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

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.clientGrants.list({
        include_totals: true,
        from: "from",
        take: 1,
        audience: "audience",
        client_id: "client_id",
        allow_any_organization: true,
        subject_type: "client",
        default_for: "third_party_clients"
    })
```

create

create(
request: CreateClientGrantRequestContent,
requestOptions?: ClientGrantsClient.RequestOptions,
): HttpResponsePromise<CreateClientGrantResponseContent>
Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow.
Parameters
- request: CreateClientGrantRequestContent
- OptionalrequestOptions: ClientGrantsClient.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

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.clientGrants.create({
        audience: "audience"
    })
```

search

search(
    request?: SearchClientGrantsRequestParameters,
    requestOptions?: ClientGrantsClient.RequestOptions,
): Promise<
    Page<ClientGrantResponseContent, SearchClientGrantsResponseContent>,
>
Search client grants using SCIM or Lucene filter syntax with low-latency, eventually consistent results. Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene"). This endpoint provides an alternative to the standard GET /client-grants endpoint with better performance for complex queries. Results may not reflect recent updates immediately.
Parameters
- request: SearchClientGrantsRequestParameters = {}
- OptionalrequestOptions: ClientGrantsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<ClientGrantResponseContent, SearchClientGrantsResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
Management.InternalServerError

Throws
Management.GatewayTimeoutError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.clientGrants.search({
        q: "q",
        parser: "scim",
        fields: "fields",
        include_fields: true,
        take: 1,
        from: "from",
        sort: "audience"
    })
```

get

get(
id: string,
requestOptions?: ClientGrantsClient.RequestOptions,
): HttpResponsePromise<GetClientGrantResponseContent>
Retrieve a single client grant, including the scopes associated with the application/API pair.
Parameters
- id: string
  The ID of the client grant to retrieve.
- OptionalrequestOptions: ClientGrantsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetClientGrantResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.clientGrants.get("id")
```

delete

delete(
id: string,
requestOptions?: ClientGrantsClient.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: ClientGrantsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.clientGrants.delete("id")
```

update

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.clientGrants.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_organizations

_organizations: OrganizationsClient | undefined

Class ClientGrantsClient

Index

Accessors

Constructors

Methods

Properties

Accessors

organizations

Returns OrganizationsClient

Constructors

constructor

Parameters

Returns ClientGrantsClient

Methods

list

Parameters

Returns Promise< Page< ClientGrantResponseContent, ListClientGrantPaginatedResponseContent, >,>

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateClientGrantResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

search

Parameters

Returns Promise<Page<ClientGrantResponseContent, SearchClientGrantsResponseContent>>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetClientGrantResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateClientGrantResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

Properties

Returns Promise<
Page<
ClientGrantResponseContent,
ListClientGrantPaginatedResponseContent,
>,
>

`Protected` `Readonly`_options

`Protected`_organizations