Skip to main content

Interface: IApiKey

identity.v1.IApiKey

Properties of an ApiKey.

Hierarchy​

Properties​

asyncOperationId​

• Optional asyncOperationId: null | string

The id of the async operation that is creating/updating/deleting the API key, if any.

Inherited from​

$Properties.asyncOperationId

createdTime​

• Optional createdTime: null | $Properties

The date and time when the API key was created.

Inherited from​

$Properties.createdTime

id​

• Optional id: null | string

The id of the API Key.

Inherited from​

$Properties.id

lastModifiedTime​

• Optional lastModifiedTime: null | $Properties

The date and time when the API key was last modified. Will not be set if the API key has never been modified.

Inherited from​

$Properties.lastModifiedTime

resourceVersion​

• Optional resourceVersion: null | string

The current version of the API key specification. The next update operation will have to include this version.

Inherited from​

$Properties.resourceVersion

spec​

• Optional spec: null | $Properties

The API key specification.

Inherited from​

$Properties.spec

state​

• Optional state: null | ResourceState

The current state of the API key. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=state_deprecated

Inherited from​

$Properties.state

stateDeprecated​

• Optional stateDeprecated: null | string

The current state of the API key. Possible values: activating, activationfailed, active, updating, updatefailed, deleting, deletefailed, deleted, suspending, suspendfailed, suspended. For any failed state, reach out to Temporal Cloud support for remediation. Deprecated: Not supported after v0.3.0 api version. Use state instead. temporal:versioning:max_version=v0.3.0

Inherited from​

$Properties.stateDeprecated