Interface: $Properties

v1.ApiKeySpec.$Properties

Properties of an ApiKeySpec.

Hierarchy

• $Properties

  ↳ IApiKeySpec

Properties

description

• Optional description: null | string

The description of the API key.

---

disabled

• Optional disabled: null | boolean

True if the API key is disabled.

---

displayName

• Optional displayName: null | string

The display name of the API key.

---

expiryTime

• Optional expiryTime: null | $Properties

The expiry time of the API key.

---

ownerId

• Optional ownerId: null | string

The id of the owner to create the API key for. The owner id is immutable. Once set during creation, it cannot be changed. The owner id is the id of the user when the owner type is user. The owner id is the id of the service account when the owner type is service account.

---

ownerType

• Optional ownerType: null | OwnerType

The type of the owner to create the API key for. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=owner_type_deprecated

---

ownerTypeDeprecated

• Optional ownerTypeDeprecated: null | string

The type of the owner to create the API key for. The owner type is immutable. Once set during creation, it cannot be changed. Possible values: user, service-account. Deprecated: Not supported after v0.3.0 api version. Use owner_type instead. temporal:versioning:max_version=v0.3.0