Console
    Start free

    REST Resource: projects.locations.singleTenantHsmInstances

    Resource: SingleTenantHsmInstance

    A SingleTenantHsmInstance represents a single-tenant HSM instance. It can be used for creating CryptoKeys with a ProtectionLevel of HSM_SINGLE_TENANT , as well as performing cryptographic operations using keys created within the SingleTenantHsmInstance .

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "quorumAuth" 
 : 
 { 
 object (  QuorumAuth 
 
) 
 } 
 , 
 "deleteTime" 
 : 
 string 
 , 
 "unrefreshedDurationUntilDisable" 
 : 
 string 
 , 
 "disableTime" 
 : 
 string 
 }
    Fields
    name

    string

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

    string ( Timestamp format)

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

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    state

    enum ( State )

    Output only. The state of the SingleTenantHsmInstance .
    quorumAuth

    object ( QuorumAuth )

    Required. The quorum auth configuration for the SingleTenantHsmInstance .
    deleteTime

    string ( Timestamp format)

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

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    unrefreshedDurationUntilDisable

    string ( Duration format)

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

    A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
    disableTime

    string ( Timestamp format)

    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.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    State

    The set of states of a SingleTenantHsmInstance .

    Enums
    STATE_UNSPECIFIED Not specified.
    CREATING The SingleTenantHsmInstance is being created.
    PENDING_TWO_FACTOR_AUTH_REGISTRATION The SingleTenantHsmInstance is waiting for 2FA keys to be registered. This can be done by calling proposals.create with the RegisterTwoFactorAuthKeys operation.
    ACTIVE The SingleTenantHsmInstance is ready to use. A SingleTenantHsmInstance must be in the ACTIVE state for all CryptoKeys created within the SingleTenantHsmInstance to be usable.
    DISABLING The SingleTenantHsmInstance is being disabled.
    DISABLED The SingleTenantHsmInstance is disabled.
    DELETING The SingleTenantHsmInstance is being deleted. Requests to the instance will be rejected in this state.
    DELETED The SingleTenantHsmInstance has been deleted.
    FAILED The SingleTenantHsmInstance has failed and can not be recovered or used.

    QuorumAuth

    Configuration for M of N quorum auth.

    JSON representation 
     { 
 "totalApproverCount" 
 : 
 integer 
 , 
 "requiredApproverCount" 
 : 
 integer 
 , 
 "twoFactorPublicKeyPems" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    totalApproverCount

    integer

    Required. The total number of approvers. This is the N value used for M of N quorum auth. Must be greater than or equal to 3 and less than or equal to 16.
    requiredApproverCount

    integer

    Output only. The required numbers of approvers. The M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to totalApproverCount - 1.
    twoFactorPublicKeyPems[]

    string

    Output only. The public keys associated with the 2FA keys for M of N quorum auth.

    Methods

    create

    		Creates a new SingleTenantHsmInstance in a given Project and Location.

    get

    		Returns metadata for a given SingleTenantHsmInstance .

    list

    		Lists SingleTenantHsmInstances .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: