docs/classes/management.SDK.CredentialsClient.html
new CredentialsClient(options: BaseClientOptions): CredentialsClient
list(
client_id: string,
requestOptions?: CredentialsClient.RequestOptions,
): HttpResponsePromise<ClientCredential[]>
Get the details of a client credential.
Important : To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
ID of the client.
OptionalrequestOptions: CredentialsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clients.credentials.list("client_id")Copy
create(
client_id: string,
request: PostClientCredentialRequestContent,
requestOptions?: CredentialsClient.RequestOptions,
): HttpResponsePromise<PostClientCredentialResponseContent>
Create a client credential associated to your application. Credentials can be used to configure Private Key JWT and mTLS authentication methods, as well as for JWT-secured Authorization requests.
Public Key credentials can be used to set up Private Key JWT client authentication and JWT-secured Authorization requests.
Sample:
{
"credential_type": "public_key",
"name": "string",
"pem": "string",
"alg": "RS256",
"parse_expiry_from_cert": false,
"expires_at": "2022-12-31T23:59:59Z"
}
Certificate credentials can be used to set up mTLS client authentication. CA-signed certificates can be configured either with a signed certificate or with just the certificate Subject DN.
CA-signed Certificate Sample (pem):
{
"credential_type": "x509_cert",
"name": "string",
"pem": "string"
}
CA-signed Certificate Sample (subject_dn):
{
"credential_type": "cert_subject_dn",
"name": "string",
"subject_dn": "string"
}
Self-signed Certificate Sample:
{
"credential_type": "cert_subject_dn",
"name": "string",
"pem": "string"
}
The credential will be created but not yet enabled for use until you set the corresponding properties in the client:
client_authentication_methods property on the client. For more information, read Configure Private Key JWT Authentication and Configure mTLS Authenticationsigned_request_objectproperty on the client. For more information, read Configure JWT-secured Authorization Requests (JAR)ID of the client.
OptionalrequestOptions: CredentialsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clients.credentials.create("client_id", { credential_type: "public_key" })Copy
get(
client_id: string,
credential_id: string,
requestOptions?: CredentialsClient.RequestOptions,
): HttpResponsePromise<GetClientCredentialResponseContent>
Get the details of a client credential.
Important : To enable credentials to be used for a client authentication method, set the client_authentication_methods property on the client. To enable credentials to be used for JWT-Secured Authorization requests set the signed_request_object property on the client.
ID of the client.
ID of the credential.
OptionalrequestOptions: CredentialsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clients.credentials.get("client_id", "credential_id")Copy
delete(
client_id: string,
credential_id: string,
requestOptions?: CredentialsClient.RequestOptions,
): HttpResponsePromise<void>
Delete a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
ID of the client.
ID of the credential to delete.
OptionalrequestOptions: CredentialsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clients.credentials.delete("client_id", "credential_id")Copy
update(
client_id: string,
credential_id: string,
request?: PatchClientCredentialRequestContent,
requestOptions?: CredentialsClient.RequestOptions,
): HttpResponsePromise<PatchClientCredentialResponseContent>
Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.
ID of the client.
ID of the credential.
OptionalrequestOptions: CredentialsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.clients.credentials.update("client_id", "credential_id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listcreategetdeleteupdate Properties _options