Interface: IApiKey

Properties of an ApiKey.

Extends

• $Properties

Properties

asyncOperationId?

optional asyncOperationId?: string | null

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

Inherited from

$Properties.asyncOperationId

---

createdTime?

optional createdTime?: $Properties | null

The date and time when the API key was created.

Inherited from

$Properties.createdTime

---

id?

optional id?: string | null

The id of the API Key.

Inherited from

$Properties.id

---

lastModifiedTime?

optional lastModifiedTime?: $Properties | null

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?: string | null

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?: $Properties | null

The API key specification.

Inherited from

$Properties.spec

---

state?

optional state?: ResourceState | null

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?: string | null

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