Class KeysClient

Index

Constructors

Methods

Properties

Constructors

constructor

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

Methods

get

get(
id: string,
requestOptions?: KeysClient.RequestOptions,
): HttpResponsePromise<ConnectionKey[]>
Gets the connection keys for the Okta or OIDC connection strategy.
Parameters
- id: string
  ID of the connection
- OptionalrequestOptions: KeysClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<ConnectionKey[]>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.connections.keys.get("id")
```

rotate

rotate(
    id: string,
    request?: RotateConnectionKeysRequestContent | null,
    requestOptions?: KeysClient.RequestOptions,
): HttpResponsePromise<RotateConnectionsKeysResponseContent>
Rotates the connection keys for the Okta or OIDC connection strategies.
Parameters
- id: string
  ID of the connection
- Optionalrequest: RotateConnectionKeysRequestContent | null
- OptionalrequestOptions: KeysClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<RotateConnectionsKeysResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.connections.keys.rotate("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>