Cloud Key Management Service (KMS) API (cloudkms:v1)

Additions

Methods


• ▼ ▲ cloudkms.projects.locations.singleTenantHsmInstances.list

  Path : v1/{+parent}/singleTenantHsmInstances

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/singleTenantHsmInstances

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The resource name of the location associated with the SingleTenantHsmInstances to list, in the format `projects/*/locations/*`.

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : Optional. Optional limit on the number of SingleTenantHsmInstances to include in the response. Further SingleTenantHsmInstances can subsequently be obtained by including the ListSingleTenantHsmInstancesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstancesResponse.next_page_token.

  Location : query

  Type : string

  filter

  Description : 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).

  Location : query

  Type : string

  orderBy

  Description : 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).

  Location : query

  Type : string

  showDeleted

  Description : Optional. If set to true, HsmManagement.ListSingleTenantHsmInstances will also return SingleTenantHsmInstances in DELETED state.

  Location : query

  Type : boolean

  Parameter Order : parent

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : Lists SingleTenantHsmInstances.

• ▼ ▲ cloudkms.projects.locations.singleTenantHsmInstances.get

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/singleTenantHsmInstances/{singleTenantHsmInstancesId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the SingleTenantHsmInstance to get.

  Pattern : ^projects/[^/]+/locations/[^/]+/singleTenantHsmInstances/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : Returns metadata for a given SingleTenantHsmInstance.

• ▼ ▲ cloudkms.projects.locations.singleTenantHsmInstances.create

  Path : v1/{+parent}/singleTenantHsmInstances

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/singleTenantHsmInstances

  HTTP Method : POST

  Parameters :

  parent

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

  Pattern : ^projects/[^/]+/locations/[^/]+$

  Location : path

  Required : Yes

  Type : string

  singleTenantHsmInstanceId

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

  Location : query

  Type : string

  Parameter Order : parent

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : 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.

• ▼ ▲ cloudkms.projects.locations.singleTenantHsmInstances.proposals.create

  Path : v1/{+parent}/proposals

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/singleTenantHsmInstances/{singleTenantHsmInstancesId}/proposals

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The name of the SingleTenantHsmInstance associated with the SingleTenantHsmInstanceProposals.

  Pattern : ^projects/[^/]+/locations/[^/]+/singleTenantHsmInstances/[^/]+$

  Location : path

  Required : Yes

  Type : string

  singleTenantHsmInstanceProposalId

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

  Location : query

  Type : string

  Parameter Order : parent

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : Creates a new SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance.

• ▼ ▲ cloudkms.projects.locations.singleTenantHsmInstances.proposals.approve

  Path : v1/{+name}:approve

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/singleTenantHsmInstances/{singleTenantHsmInstancesId}/proposals/{proposalsId}:approve

  HTTP Method : POST

  Parameters :

  name

  Description : Required. The name of the SingleTenantHsmInstanceProposal to approve.

  Pattern : ^projects/[^/]+/locations/[^/]+/singleTenantHsmInstances/[^/]+/proposals/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : Approves a SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance. The proposal must be in the PENDING state.

• ▼ ▲ cloudkms.projects.locations.singleTenantHsmInstances.proposals.execute

  Path : v1/{+name}:execute

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/singleTenantHsmInstances/{singleTenantHsmInstancesId}/proposals/{proposalsId}:execute

  HTTP Method : POST

  Parameters :

  name

  Description : Required. The name of the SingleTenantHsmInstanceProposal to execute.

  Pattern : ^projects/[^/]+/locations/[^/]+/singleTenantHsmInstances/[^/]+/proposals/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : Executes a SingleTenantHsmInstanceProposal for a given SingleTenantHsmInstance. The proposal must be in the APPROVED state.

• ▼ ▲ cloudkms.projects.locations.singleTenantHsmInstances.proposals.get

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/singleTenantHsmInstances/{singleTenantHsmInstancesId}/proposals/{proposalsId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the SingleTenantHsmInstanceProposal to get.

  Pattern : ^projects/[^/]+/locations/[^/]+/singleTenantHsmInstances/[^/]+/proposals/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : Returns metadata for a given SingleTenantHsmInstanceProposal.

• ▼ ▲ cloudkms.projects.locations.singleTenantHsmInstances.proposals.list

  Path : v1/{+parent}/proposals

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/singleTenantHsmInstances/{singleTenantHsmInstancesId}/proposals

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The resource name of the location associated with the SingleTenantHsmInstanceProposals to list, in the format `projects/*/locations/*/singleTenantHsmInstances/*`.

  Pattern : ^projects/[^/]+/locations/[^/]+/singleTenantHsmInstances/[^/]+$

  Location : path

  Required : Yes

  Type : string

  pageSize

  Description : 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.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstanceProposalsResponse.next_page_token.

  Location : query

  Type : string

  filter

  Description : 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).

  Location : query

  Type : string

  orderBy

  Description : 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).

  Location : query

  Type : string

  showDeleted

  Description : Optional. If set to true, HsmManagement.ListSingleTenantHsmInstanceProposals will also return SingleTenantHsmInstanceProposals in DELETED state.

  Location : query

  Type : boolean

  Parameter Order : parent

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : Lists SingleTenantHsmInstanceProposals.

• ▼ ▲ cloudkms.projects.locations.singleTenantHsmInstances.proposals.delete

  Path : v1/{+name}

  Flat Path : v1/projects/{projectsId}/locations/{locationsId}/singleTenantHsmInstances/{singleTenantHsmInstancesId}/proposals/{proposalsId}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The name of the SingleTenantHsmInstanceProposal to delete.

  Pattern : ^projects/[^/]+/locations/[^/]+/singleTenantHsmInstances/[^/]+/proposals/[^/]+$

  Location : path

  Required : Yes

  Type : string

  Parameter Order : name

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudkms

  Description : Deletes a SingleTenantHsmInstanceProposal.