docs/classes/management.SDK.KeysClient.html
new KeysClient(options: BaseClientOptions): KeysClient
get(
id: string,
requestOptions?: KeysClient.RequestOptions,
): HttpResponsePromise<ConnectionKey[]>
Gets the connection keys for the Okta or OIDC connection strategy.
ID of the connection
OptionalrequestOptions: KeysClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.connections.keys.get("id")Copy
create(
id: string,
request?: PostConnectionKeysRequestContent | null,
requestOptions?: KeysClient.RequestOptions,
): HttpResponsePromise<PostConnectionsKeysResponseContent>
Provision initial connection keys for Okta or OIDC connection strategies. This endpoint allows you to create keys before configuring the connection to use Private Key JWT authentication, enabling zero-downtime transitions.
ID of the connection
Optionalrequest: PostConnectionKeysRequestContent | nullOptionalrequestOptions: KeysClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.connections.keys.create("id")Copy
rotate(
id: string,
request?: RotateConnectionKeysRequestContent | null,
requestOptions?: KeysClient.RequestOptions,
): HttpResponsePromise<RotateConnectionsKeysResponseContent>
Rotates the connection keys for the Okta or OIDC connection strategies.
ID of the connection
Optionalrequest: RotateConnectionKeysRequestContent | nullOptionalrequestOptions: KeysClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.connections.keys.rotate("id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods getcreaterotate Properties _options