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

2022-09-23

3 new methods

Additions

    Methods
  • cloudkms.projects.locations.ekmConfig.getIamPolicy

      Path: v1/{+resource}:getIamPolicy

      Parameter Order: resource

      Parameters:

        options.requestedPolicyVersion

          Location: query

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Type: integer

          Format: int32

        resource

          Required: Yes

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

          Location: path

          Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type: string

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloudkms
    • Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConfig:getIamPolicy

      HTTP Method: GET

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • cloudkms.projects.locations.ekmConfig.setIamPolicy

      Parameters:

        resource

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

          Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Type: string

          Required: Yes

          Location: path

      Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

      Parameter Order: resource

      HTTP Method: POST

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloudkms
    • Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConfig:setIamPolicy

      Path: v1/{+resource}:setIamPolicy

  • cloudkms.projects.locations.ekmConfig.testIamPermissions

      Parameter Order: resource

      HTTP Method: POST

      Scopes:

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

        resource

          Type: string

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

          Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Location: path

          Required: Yes

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConfig:testIamPermissions

      Path: v1/{+resource}:testIamPermissions

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

3 removed methods

Deletions

    Methods
  • cloudkms.projects.locations.ekmConfig.setIamPolicy

      Parameter Order: resource

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloudkms
    • Path: v1/{+resource}:setIamPolicy

      Parameters:

        resource

          Type: string

          Location: path

          Required: Yes

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

          Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

      Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConfig:setIamPolicy

  • cloudkms.projects.locations.ekmConfig.testIamPermissions

      HTTP Method: POST

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloudkms
    • Path: v1/{+resource}:testIamPermissions

      Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

      Parameters:

        resource

          Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: resource

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConfig:testIamPermissions

  • cloudkms.projects.locations.ekmConfig.getIamPolicy

      Parameter Order: resource

      Parameters:

        resource

          Required: Yes

          Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

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

          Type: string

          Location: path

        options.requestedPolicyVersion

          Location: query

          Format: int32

          Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

          Type: integer

      Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      Path: v1/{+resource}:getIamPolicy

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/ekmConfig:getIamPolicy

      Scopes:

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