Skip to main content

Interface: IApiKey

identity.v1.IApiKey

Properties of an ApiKey.

Implemented by

Properties

asyncOperationId

Optional asyncOperationId: null | string

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


createdTime

Optional createdTime: null | ITimestamp

The date and time when the API key was created.


id

Optional id: null | string

The id of the API Key.


lastModifiedTime

Optional lastModifiedTime: null | ITimestamp

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


resourceVersion

Optional resourceVersion: null | string

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


spec

Optional spec: null | IApiKeySpec

The API key specification.


state

Optional state: null | ResourceState

The current state of the API key. temporal:versioning:min_version=2024-10-01-00 temporal:enums:replaces=state_deprecated


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 2024-10-01-00 api version. Use state instead. temporal:versioning:max_version=2024-10-01-00