approve(name, body=None, x__xgafv=None)
Approves a SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance. The proposal must be in the PENDING state.
Close httplib2 connections.
create(parent, body=None, singleTenantHsmInstanceProposalId=None, x__xgafv=None)
Creates a new SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance.
Deletes a SingleTenantHsmInstanceProposal.
execute(name, body=None, x__xgafv=None)
Executes a SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance. The proposal must be in the APPROVED state.
Returns metadata for a given SingleTenantHsmInstanceProposal.
Lists SingleTenantHsmInstanceProposals.
Retrieves the next page of results.
approve(name, body=None, x__xgafv=None)
Approves a SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance. The proposal must be in the PENDING state.
Args:
name: string, Required. The name of the SingleTenantHsmInstanceProposal to approve. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for HsmManagement.ApproveSingleTenantHsmInstanceProposal.
"quorumReply": { # The reply to QuorumParameters for approving the proposal. # Required. The reply to QuorumParameters for approving the proposal.
"challengeReplies": [ # Required. The challenge replies to approve the proposal. Challenge replies can be sent across multiple requests. The proposal will be approved when required_approver_count challenge replies are provided.
{ # A reply to a challenge signed by a 2FA key.
"publicKeyPem": "A String", # Required. The public key associated with the 2FA key.
"signedChallenge": "A String", # Required. The signed challenge associated with the 2FA key. The signature must be RSASSA-PKCS1 v1.5 with a SHA256 digest.
},
],
},
"requiredActionQuorumReply": { # The reply to RequiredActionQuorumParameters for approving the proposal. # Required. The reply to RequiredActionQuorumParameters for approving the proposal.
"quorumChallengeReplies": [ # Required. Quorum members' signed challenge replies. These can be provided across multiple requests. The proposal will be approved when required_approver_count quorum_challenge_replies are provided and when all required_challenge_replies are provided.
{ # A reply to a challenge signed by a 2FA key.
"publicKeyPem": "A String", # Required. The public key associated with the 2FA key.
"signedChallenge": "A String", # Required. The signed challenge associated with the 2FA key. The signature must be RSASSA-PKCS1 v1.5 with a SHA256 digest.
},
],
"requiredChallengeReplies": [ # Required. All required challenges must be signed for the proposal to be approved. These can be sent across multiple requests.
{ # A reply to a challenge signed by a 2FA key.
"publicKeyPem": "A String", # Required. The public key associated with the 2FA key.
"signedChallenge": "A String", # Required. The signed challenge associated with the 2FA key. The signature must be RSASSA-PKCS1 v1.5 with a SHA256 digest.
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for HsmManagement.ApproveSingleTenantHsmInstanceProposal.
}
close()
Close httplib2 connections.
create(parent, body=None, singleTenantHsmInstanceProposalId=None, x__xgafv=None)
Creates a new SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance.
Args:
parent: string, Required. The name of the SingleTenantHsmInstance associated with the SingleTenantHsmInstanceProposals. (required)
body: object, The request body.
The object takes the form of:
{ # A SingleTenantHsmInstanceProposal represents a proposal to perform an operation on a SingleTenantHsmInstance.
"addQuorumMember": { # Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
"twoFactorPublicKeyPem": "A String", # Required. The public key associated with the 2FA key for the new quorum member to add. Public keys must be associated with RSA 2048 keys.
},
"createTime": "A String", # Output only. The time at which the SingleTenantHsmInstanceProposal was created.
"deleteSingleTenantHsmInstance": { # Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must not be in the DELETING or DELETED state to perform this operation. # Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
},
"deleteTime": "A String", # Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.
"disableSingleTenantHsmInstance": { # Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
},
"enableSingleTenantHsmInstance": { # Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation. # Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.
},
"expireTime": "A String", # The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.
"failureReason": "A String", # Output only. The root cause of the most recent failure. Only present if state is FAILED.
"name": "A String", # Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*/proposals/*`.
"purgeTime": "A String", # Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).
"quorumParameters": { # Parameters of quorum approval for the SingleTenantHsmInstanceProposal. # Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.
"approvedTwoFactorPublicKeyPems": [ # Output only. The public keys associated with the 2FA keys that have already approved the SingleTenantHsmInstanceProposal by signing the challenge.
"A String",
],
"challenges": [ # Output only. The challenges to be signed by 2FA keys for quorum auth. M of N of these challenges are required to be signed to approve the operation.
{ # A challenge to be signed by a 2FA key.
"challenge": "A String", # Output only. The challenge to be signed by the 2FA key indicated by the public key.
"publicKeyPem": "A String", # Output only. The public key associated with the 2FA key that should sign the challenge.
},
],
"requiredApproverCount": 42, # Output only. The required numbers of approvers. This is the M value used for M of N quorum auth. It is less than the number of public keys.
},
"refreshSingleTenantHsmInstance": { # Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
},
"registerTwoFactorAuthKeys": { # Register 2FA keys for the SingleTenantHsmInstance. This operation requires all Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation. # Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
"requiredApproverCount": 42, # Required. The required numbers of approvers to set for the SingleTenantHsmInstance. This is the M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to total_approver_count - 1.
"twoFactorPublicKeyPems": [ # Required. The public keys associated with the 2FA keys for M of N quorum auth. Public keys must be associated with RSA 2048 keys.
"A String",
],
},
"removeQuorumMember": { # Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
"twoFactorPublicKeyPem": "A String", # Required. The public key associated with the 2FA key for the quorum member to remove. Public keys must be associated with RSA 2048 keys.
},
"requiredActionQuorumParameters": { # Parameters for an approval that has both required challenges and a quorum. # Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.
"approvedTwoFactorPublicKeyPems": [ # Output only. The public keys associated with the 2FA keys that have already approved the SingleTenantHsmInstanceProposal by signing the challenge.
"A String",
],
"quorumChallenges": [ # Output only. The challenges to be signed by 2FA keys for quorum auth. M of N of these challenges are required to be signed to approve the operation.
{ # A challenge to be signed by a 2FA key.
"challenge": "A String", # Output only. The challenge to be signed by the 2FA key indicated by the public key.
"publicKeyPem": "A String", # Output only. The public key associated with the 2FA key that should sign the challenge.
},
],
"requiredApproverCount": 42, # Output only. The required number of quorum approvers. This is the M value used for M of N quorum auth. It is less than the number of public keys.
"requiredChallenges": [ # Output only. A list of specific challenges that must be signed. For some operations, this will contain a single challenge.
{ # A challenge to be signed by a 2FA key.
"challenge": "A String", # Output only. The challenge to be signed by the 2FA key indicated by the public key.
"publicKeyPem": "A String", # Output only. The public key associated with the 2FA key that should sign the challenge.
},
],
},
"state": "A String", # Output only. The state of the SingleTenantHsmInstanceProposal.
"ttl": "A String", # Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.
}
singleTenantHsmInstanceProposalId: string, Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, x__xgafv=None)
Deletes a SingleTenantHsmInstanceProposal.
Args:
name: string, Required. The name of the SingleTenantHsmInstanceProposal to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
execute(name, body=None, x__xgafv=None)
Executes a SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance. The proposal must be in the APPROVED state.
Args:
name: string, Required. The name of the SingleTenantHsmInstanceProposal to execute. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for HsmManagement.ExecuteSingleTenantHsmInstanceProposal.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Returns metadata for a given SingleTenantHsmInstanceProposal.
Args:
name: string, Required. The name of the SingleTenantHsmInstanceProposal to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A SingleTenantHsmInstanceProposal represents a proposal to perform an operation on a SingleTenantHsmInstance.
"addQuorumMember": { # Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
"twoFactorPublicKeyPem": "A String", # Required. The public key associated with the 2FA key for the new quorum member to add. Public keys must be associated with RSA 2048 keys.
},
"createTime": "A String", # Output only. The time at which the SingleTenantHsmInstanceProposal was created.
"deleteSingleTenantHsmInstance": { # Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must not be in the DELETING or DELETED state to perform this operation. # Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
},
"deleteTime": "A String", # Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.
"disableSingleTenantHsmInstance": { # Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
},
"enableSingleTenantHsmInstance": { # Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation. # Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.
},
"expireTime": "A String", # The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.
"failureReason": "A String", # Output only. The root cause of the most recent failure. Only present if state is FAILED.
"name": "A String", # Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*/proposals/*`.
"purgeTime": "A String", # Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).
"quorumParameters": { # Parameters of quorum approval for the SingleTenantHsmInstanceProposal. # Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.
"approvedTwoFactorPublicKeyPems": [ # Output only. The public keys associated with the 2FA keys that have already approved the SingleTenantHsmInstanceProposal by signing the challenge.
"A String",
],
"challenges": [ # Output only. The challenges to be signed by 2FA keys for quorum auth. M of N of these challenges are required to be signed to approve the operation.
{ # A challenge to be signed by a 2FA key.
"challenge": "A String", # Output only. The challenge to be signed by the 2FA key indicated by the public key.
"publicKeyPem": "A String", # Output only. The public key associated with the 2FA key that should sign the challenge.
},
],
"requiredApproverCount": 42, # Output only. The required numbers of approvers. This is the M value used for M of N quorum auth. It is less than the number of public keys.
},
"refreshSingleTenantHsmInstance": { # Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
},
"registerTwoFactorAuthKeys": { # Register 2FA keys for the SingleTenantHsmInstance. This operation requires all Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation. # Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
"requiredApproverCount": 42, # Required. The required numbers of approvers to set for the SingleTenantHsmInstance. This is the M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to total_approver_count - 1.
"twoFactorPublicKeyPems": [ # Required. The public keys associated with the 2FA keys for M of N quorum auth. Public keys must be associated with RSA 2048 keys.
"A String",
],
},
"removeQuorumMember": { # Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
"twoFactorPublicKeyPem": "A String", # Required. The public key associated with the 2FA key for the quorum member to remove. Public keys must be associated with RSA 2048 keys.
},
"requiredActionQuorumParameters": { # Parameters for an approval that has both required challenges and a quorum. # Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.
"approvedTwoFactorPublicKeyPems": [ # Output only. The public keys associated with the 2FA keys that have already approved the SingleTenantHsmInstanceProposal by signing the challenge.
"A String",
],
"quorumChallenges": [ # Output only. The challenges to be signed by 2FA keys for quorum auth. M of N of these challenges are required to be signed to approve the operation.
{ # A challenge to be signed by a 2FA key.
"challenge": "A String", # Output only. The challenge to be signed by the 2FA key indicated by the public key.
"publicKeyPem": "A String", # Output only. The public key associated with the 2FA key that should sign the challenge.
},
],
"requiredApproverCount": 42, # Output only. The required number of quorum approvers. This is the M value used for M of N quorum auth. It is less than the number of public keys.
"requiredChallenges": [ # Output only. A list of specific challenges that must be signed. For some operations, this will contain a single challenge.
{ # A challenge to be signed by a 2FA key.
"challenge": "A String", # Output only. The challenge to be signed by the 2FA key indicated by the public key.
"publicKeyPem": "A String", # Output only. The public key associated with the 2FA key that should sign the challenge.
},
],
},
"state": "A String", # Output only. The state of the SingleTenantHsmInstanceProposal.
"ttl": "A String", # Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Lists SingleTenantHsmInstanceProposals.
Args:
parent: string, Required. The resource name of the location associated with the SingleTenantHsmInstanceProposals to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`. (required)
filter: string, Optional. Only include resources that match the filter in the response. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
orderBy: string, Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see [Sorting and filtering list results](https://cloud.google.com/kms/docs/sorting-and-filtering).
pageSize: integer, Optional. Optional limit on the number of SingleTenantHsmInstanceProposals to include in the response. Further SingleTenantHsmInstanceProposals can subsequently be obtained by including the ListSingleTenantHsmInstanceProposalsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
pageToken: string, Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstanceProposalsResponse.next_page_token.
showDeleted: boolean, Optional. If set to true, HsmManagement.ListSingleTenantHsmInstanceProposals will also return SingleTenantHsmInstanceProposals in DELETED state.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for HsmManagement.ListSingleTenantHsmInstanceProposals.
"nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListSingleTenantHsmInstanceProposalsRequest.page_token to retrieve the next page of results.
"singleTenantHsmInstanceProposals": [ # The list of SingleTenantHsmInstanceProposals.
{ # A SingleTenantHsmInstanceProposal represents a proposal to perform an operation on a SingleTenantHsmInstance.
"addQuorumMember": { # Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Add a quorum member to the SingleTenantHsmInstance. This will increase the total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
"twoFactorPublicKeyPem": "A String", # Required. The public key associated with the 2FA key for the new quorum member to add. Public keys must be associated with RSA 2048 keys.
},
"createTime": "A String", # Output only. The time at which the SingleTenantHsmInstanceProposal was created.
"deleteSingleTenantHsmInstance": { # Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must not be in the DELETING or DELETED state to perform this operation. # Delete the SingleTenantHsmInstance. Deleting a SingleTenantHsmInstance will make all CryptoKeys attached to the SingleTenantHsmInstance unusable. The SingleTenantHsmInstance must be in the DISABLED or PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
},
"deleteTime": "A String", # Output only. The time at which the SingleTenantHsmInstanceProposal was deleted.
"disableSingleTenantHsmInstance": { # Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Disable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
},
"enableSingleTenantHsmInstance": { # Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation. # Enable the SingleTenantHsmInstance. The SingleTenantHsmInstance must be in the DISABLED state to perform this operation.
},
"expireTime": "A String", # The time at which the SingleTenantHsmInstanceProposal will expire if not approved and executed.
"failureReason": "A String", # Output only. The root cause of the most recent failure. Only present if state is FAILED.
"name": "A String", # Identifier. The resource name for this SingleTenantHsmInstance in the format `projects/*/locations/*/singleTenantHsmInstances/*/proposals/*`.
"purgeTime": "A String", # Output only. The time at which the soft-deleted SingleTenantHsmInstanceProposal will be permanently purged. This field is only populated when the state is DELETED and will be set a time after expiration of the proposal, i.e. >= expire_time or (create_time + ttl).
"quorumParameters": { # Parameters of quorum approval for the SingleTenantHsmInstanceProposal. # Output only. The quorum approval parameters for the SingleTenantHsmInstanceProposal.
"approvedTwoFactorPublicKeyPems": [ # Output only. The public keys associated with the 2FA keys that have already approved the SingleTenantHsmInstanceProposal by signing the challenge.
"A String",
],
"challenges": [ # Output only. The challenges to be signed by 2FA keys for quorum auth. M of N of these challenges are required to be signed to approve the operation.
{ # A challenge to be signed by a 2FA key.
"challenge": "A String", # Output only. The challenge to be signed by the 2FA key indicated by the public key.
"publicKeyPem": "A String", # Output only. The public key associated with the 2FA key that should sign the challenge.
},
],
"requiredApproverCount": 42, # Output only. The required numbers of approvers. This is the M value used for M of N quorum auth. It is less than the number of public keys.
},
"refreshSingleTenantHsmInstance": { # Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Refreshes the SingleTenantHsmInstance. This operation must be performed periodically to keep the SingleTenantHsmInstance active. This operation must be performed before unrefreshed_duration_until_disable has passed. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
},
"registerTwoFactorAuthKeys": { # Register 2FA keys for the SingleTenantHsmInstance. This operation requires all Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation. # Register 2FA keys for the SingleTenantHsmInstance. This operation requires all N Challenges to be signed by 2FA keys. The SingleTenantHsmInstance must be in the PENDING_TWO_FACTOR_AUTH_REGISTRATION state to perform this operation.
"requiredApproverCount": 42, # Required. The required numbers of approvers to set for the SingleTenantHsmInstance. This is the M value used for M of N quorum auth. Must be greater than or equal to 2 and less than or equal to total_approver_count - 1.
"twoFactorPublicKeyPems": [ # Required. The public keys associated with the 2FA keys for M of N quorum auth. Public keys must be associated with RSA 2048 keys.
"A String",
],
},
"removeQuorumMember": { # Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation. # Remove a quorum member from the SingleTenantHsmInstance. This will reduce total_approver_count by 1. The SingleTenantHsmInstance must be in the ACTIVE state to perform this operation.
"twoFactorPublicKeyPem": "A String", # Required. The public key associated with the 2FA key for the quorum member to remove. Public keys must be associated with RSA 2048 keys.
},
"requiredActionQuorumParameters": { # Parameters for an approval that has both required challenges and a quorum. # Output only. Parameters for an approval of a SingleTenantHsmInstanceProposal that has both required challenges and a quorum.
"approvedTwoFactorPublicKeyPems": [ # Output only. The public keys associated with the 2FA keys that have already approved the SingleTenantHsmInstanceProposal by signing the challenge.
"A String",
],
"quorumChallenges": [ # Output only. The challenges to be signed by 2FA keys for quorum auth. M of N of these challenges are required to be signed to approve the operation.
{ # A challenge to be signed by a 2FA key.
"challenge": "A String", # Output only. The challenge to be signed by the 2FA key indicated by the public key.
"publicKeyPem": "A String", # Output only. The public key associated with the 2FA key that should sign the challenge.
},
],
"requiredApproverCount": 42, # Output only. The required number of quorum approvers. This is the M value used for M of N quorum auth. It is less than the number of public keys.
"requiredChallenges": [ # Output only. A list of specific challenges that must be signed. For some operations, this will contain a single challenge.
{ # A challenge to be signed by a 2FA key.
"challenge": "A String", # Output only. The challenge to be signed by the 2FA key indicated by the public key.
"publicKeyPem": "A String", # Output only. The public key associated with the 2FA key that should sign the challenge.
},
],
},
"state": "A String", # Output only. The state of the SingleTenantHsmInstanceProposal.
"ttl": "A String", # Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.
},
],
"totalSize": 42, # The total number of SingleTenantHsmInstanceProposals that matched the query. This field is not populated if ListSingleTenantHsmInstanceProposalsRequest.filter is applied.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.