docs/classes/management.SDK.ClientGrantsClient.html
get organizations(): OrganizationsClient
new ClientGrantsClient(options: BaseClientOptions): ClientGrantsClient
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.
OptionalrequestOptions: ClientGrantsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clientGrants.list({ from: "from", take: 1, audience: "audience", client_id: "client_id", allow_any_organization: true, subject_type: "client", default_for: "third_party_clients" })Copy
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.
OptionalrequestOptions: ClientGrantsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clientGrants.create({ audience: "audience" })Copy
get(
id: string,
requestOptions?: ClientGrantsClient.RequestOptions,
): HttpResponsePromise<GetClientGrantResponseContent>
Retrieve a single client grant, including the scopes associated with the application/API pair.
The ID of the client grant to retrieve.
OptionalrequestOptions: ClientGrantsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clientGrants.get("id")Copy
delete(
id: string,
requestOptions?: ClientGrantsClient.RequestOptions,
): HttpResponsePromise<void>
Delete the Client Credential Flow from your machine-to-machine application.
ID of the client grant to delete.
OptionalrequestOptions: ClientGrantsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clientGrants.delete("id")Copy
update(
id: string,
request?: UpdateClientGrantRequestContent,
requestOptions?: ClientGrantsClient.RequestOptions,
): HttpResponsePromise<UpdateClientGrantResponseContent>
Update a client grant.
ID of the client grant to update.
OptionalrequestOptions: ClientGrantsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clientGrants.update("id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Protected_organizations_organizations: OrganizationsClient | undefined
Member Visibility
ThemeOSLightDark
Accessors organizations Constructors constructor Methods listcreategetdeleteupdate Properties _options_organizations