Class Keys

Index

Constructors

Methods

get rotate _getAuthorizationHeader

Properties

Constructors

constructor

new Keys(_options: Keys.Options): Keys
Parameters
- _options: Keys.Options
Returns Keys

Methods

get

get(
id: string,
requestOptions?: Keys.RequestOptions,
): HttpResponsePromise<ConnectionKey[]>
Gets the connection keys for the Okta or OIDC connection strategy.
Parameters
- id: string
  ID of the connection
- OptionalrequestOptions: Keys.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,
    requestOptions?: Keys.RequestOptions,
): HttpResponsePromise<RotateConnectionsKeysResponseContent>
Rotates the connection keys for the Okta or OIDC connection strategies.
Parameters
- id: string
  ID of the connection
- Optionalrequest: RotateConnectionKeysRequestContent
- OptionalrequestOptions: Keys.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", undefined)
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Keys.Options