Skip to main content

Interface: IApiKeySpec

identity.v1.IApiKeySpec

Properties of an ApiKeySpec.

Hierarchy​

Properties​

description​

• Optional description: null | string

The description of the API key.

Inherited from​

$Properties.description

disabled​

• Optional disabled: null | boolean

True if the API key is disabled.

Inherited from​

$Properties.disabled

displayName​

• Optional displayName: null | string

The display name of the API key.

Inherited from​

$Properties.displayName

expiryTime​

• Optional expiryTime: null | $Properties

The expiry time of the API key.

Inherited from​

$Properties.expiryTime

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.

Inherited from​

$Properties.ownerId

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

Inherited from​

$Properties.ownerType

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

Inherited from​

$Properties.ownerTypeDeprecated