Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-134796204.9 KB
projects

Creates a new SingleTenantHsmInstance in a given Project and Location. User must create a RegisterTwoFactorAuthKeys proposal with this single-tenant HSM instance to finish setup of the instance.

post/v1/{+parent}/singleTenantHsmInstances

Path parameters

parentstring required

Required. The resource name of the location associated with the SingleTenantHsmInstance, in the format projects/*/locations/*.

Query parameters

singleTenantHsmInstanceIdstring

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}.

Request body

unrefreshedDurationUntilDisablestring google-duration

Output only. The system-defined duration that an instance can remain unrefreshed until it is automatically disabled. This will have a value of 730 days.

createTimestring google-datetime

Output only. The time at which the SingleTenantHsmInstance was created.

namestring

Identifier. The resource name for this SingleTenantHsmInstance in the format projects/*/locations/*/singleTenantHsmInstances/*.

disableTimestring google-datetime

Output only. The time at which the instance will be automatically disabled if not refreshed. This field is updated upon creation and after each successful refresh operation and enable. A RefreshSingleTenantHsmInstance operation must be made via a SingleTenantHsmInstanceProposal before this time otherwise the SingleTenantHsmInstance will become disabled.

deleteTimestring google-datetime

Output only. The time at which the SingleTenantHsmInstance was deleted.

state'STATE_UNSPECIFIED' | 'CREATING' | 'PENDING_TWO_FACTOR_AUTH_REGISTRATION' | 'ACTIVE' | 'DISABLING' | 'DISABLED' | 'DELETING' | 'DELETED' | 'FAILED'

Output only. The state of the SingleTenantHsmInstance.

keyPortabilityEnabledboolean

Optional. Immutable. Indicates whether key portability is enabled for the SingleTenantHsmInstance. This can only be set at creation time. Key portability features are disabled by default and not yet available in GA.

Response

Successful response