Identity and Access Management (IAM) API (iam:v2beta)

2022-04-19

6 new methods | New API

Additions

    Methods
  • iam.policies.createPolicy

      HTTP Method : POST

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Creates a policy.

      Flat Path : v2beta/policies/{policiesId}/{policiesId1}

      Path : v2beta/{+parent}

      Parameter Order : parent

      Parameters :

        parent

          Location : path

          Description : Required. The resource that the policy is attached to, along with the kind of policy to create. Format: `policies/{attachment-point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

          Required : Yes

          Pattern : ^policies/[^/]+/[^/]+$

          Type : string

        policyId

          Location : query

          Description : The ID to use for this policy, which will become the final component of the policy's resource name. The ID must contain 3 to 63 characters. It can contain lowercase letters and numbers, as well as dashes (`-`) and periods (`.`). The first character must be a lowercase letter.

          Type : string

  • iam.policies.listPolicies

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        parent

          Required : Yes

          Type : string

          Pattern : ^policies/[^/]+/[^/]+$

          Location : path

          Description : Required. The resource that the policy is attached to, along with the kind of policy to list. Format: `policies/{attachment-point}/denypolicies` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

        pageToken

          Description : A page token received in a ListPoliciesResponse. Provide this token to retrieve the next page.

          Location : query

          Type : string

        pageSize

          Location : query

          Format : int32

          Description : The maximum number of policies to return. IAM ignores this value and uses the value 1000.

          Type : integer

      Path : v2beta/{+parent}

      Parameter Order : parent

      Flat Path : v2beta/policies/{policiesId}/{policiesId1}

      Description : Retrieves the policies of the specified kind that are attached to a resource. The response lists only policy metadata. In particular, policy rules are omitted.

      HTTP Method : GET

  • iam.policies.update

      Description : Updates the specified policy. You can update only the rules and the display name for the policy. To update a policy, you should use a read-modify-write loop: 1. Use GetPolicy to read the current version of the policy. 2. Modify the policy as needed. 3. Use `UpdatePolicy` to write the updated policy. This pattern helps prevent conflicts between concurrent updates.

      Parameters :

        name

          Type : string

          Description : Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment-point}/denypolicies/{policy-id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.

          Required : Yes

          Pattern : ^policies/[^/]+/[^/]+/[^/]+$

          Location : path

      Flat Path : v2beta/policies/{policiesId}/{policiesId1}/{policiesId2}

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : PUT

      Path : v2beta/{+name}

  • iam.policies.delete

      Path : v2beta/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : DELETE

      Description : Deletes a policy. This action is permanent.

      Parameter Order : name

      Parameters :

        etag

          Type : string

          Description : Optional. The expected `etag` of the policy to delete. If the value does not match the value that is stored in IAM, the request fails with a `409` error code and `ABORTED` status. If you omit this field, the policy is deleted regardless of its current `etag`.

          Location : query

        name

          Location : path

          Description : Required. The resource name of the policy to delete. Format: `policies/{attachment-point}/denypolicies/{policy-id}` Use the URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

          Required : Yes

          Pattern : ^policies/[^/]+/[^/]+/[^/]+$

          Type : string

      Flat Path : v2beta/policies/{policiesId}/{policiesId1}/{policiesId2}

  • iam.policies.get

      HTTP Method : GET

      Flat Path : v2beta/policies/{policiesId}/{policiesId1}/{policiesId2}

      Parameter Order : name

      Path : v2beta/{+name}

      Description : Gets a policy.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        name

          Location : path

          Description : Required. The resource name of the policy to retrieve. Format: `policies/{attachment-point}/denypolicies/{policy-id}` Use the URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, you can use the alphanumeric or the numeric ID.

          Type : string

          Required : Yes

          Pattern : ^policies/[^/]+/[^/]+/[^/]+$

  • iam.policies.operations.get

      Path : v2beta/{+name}

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Flat Path : v2beta/policies/{policiesId}/{policiesId1}/{policiesId2}/operations/{operationsId}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : name

      HTTP Method : GET

      Parameters :

        name

          Pattern : ^policies/[^/]+/[^/]+/[^/]+/operations/[^/]+$

          Description : The name of the operation resource.

          Required : Yes

          Location : path

          Type : string