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

2025-03-27

19 new methods

Additions

    Methods
  • iam.projects.locations.workloadIdentityPools.setIamPolicy

      Path : v1/{+resource}:setIamPolicy

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

      HTTP Method : POST

      Parameters :

        resource

          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.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Sets IAM policies on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity

  • iam.projects.locations.workloadIdentityPools.getIamPolicy

      Path : v1/{+resource}:getIamPolicy

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

      HTTP Method : POST

      Parameters :

        resource

          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/[^/]+/workloadIdentityPools/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Gets IAM policies for one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity

  • iam.projects.locations.workloadIdentityPools.testIamPermissions

      Path : v1/{+resource}:testIamPermissions

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

      HTTP Method : POST

      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/[^/]+/workloadIdentityPools/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Returns the caller's permissions on one of WorkloadIdentityPool WorkloadIdentityPoolNamespace WorkloadIdentityPoolManagedIdentity

  • iam.projects.locations.workloadIdentityPools.namespaces.list

      Path : v1/{+parent}/namespaces

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent resource to list namespaces for.

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : The maximum number of namespaces to return. If unspecified, at most 50 namespaces are returned. The maximum value is 1000; values above are 1000 truncated to 1000.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : A page token, received from a previous `ListWorkloadIdentityPoolNamespaces` call. Provide this to retrieve the subsequent page.

          Location : query

          Type : string

        showDeleted

          Description : Whether to return soft-deleted namespaces.

          Location : query

          Type : boolean

      Parameter Order : parent

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

      Description : Lists all non-deleted WorkloadIdentityPoolNamespaces in a workload identity pool. If `show_deleted` is set to `true`, then deleted namespaces are also listed.

  • iam.projects.locations.workloadIdentityPools.namespaces.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the namespace to retrieve.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets an individual WorkloadIdentityPoolNamespace.

  • iam.projects.locations.workloadIdentityPools.namespaces.create

      Path : v1/{+parent}/namespaces

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent resource to create the namespace in. The only supported location is `global`.

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

          Location : path

          Required : Yes

          Type : string

        workloadIdentityPoolNamespaceId

          Description : Required. The ID to use for the namespace. This value must: * contain at most 63 characters * contain only lowercase alphanumeric characters or `-` * start with an alphanumeric character * end with an alphanumeric character The prefix "gcp-" will be reserved for future uses.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Creates a new WorkloadIdentityPoolNamespace in a WorkloadIdentityPool.

  • iam.projects.locations.workloadIdentityPools.namespaces.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Output only. The resource name of the namespace.

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Required. The list of fields to update.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates an existing WorkloadIdentityPoolNamespace in a WorkloadIdentityPool.

  • iam.projects.locations.workloadIdentityPools.namespaces.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}

      HTTP Method : DELETE

      Parameters :

        name

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes a WorkloadIdentityPoolNamespace. You can undelete a namespace for 30 days. After 30 days, deletion is permanent.

  • iam.projects.locations.workloadIdentityPools.namespaces.undelete

      Path : v1/{+name}:undelete

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}:undelete

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the namespace to undelete.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Undeletes a WorkloadIdentityPoolNamespace, as long as it was deleted fewer than 30 days ago.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.list

      Path : v1/{+parent}/managedIdentities

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent resource to list managed identities for.

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : The maximum number of managed identities to return. If unspecified, at most 50 managed identities are returned. The maximum value is 1000; values above are 1000 truncated to 1000.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : A page token, received from a previous `ListWorkloadIdentityPoolManagedIdentities` call. Provide this to retrieve the subsequent page.

          Location : query

          Type : string

        showDeleted

          Description : Whether to return soft-deleted managed identities.

          Location : query

          Type : boolean

      Parameter Order : parent

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

      Description : Lists all non-deleted WorkloadIdentityPoolManagedIdentitys in a namespace. If `show_deleted` is set to `true`, then deleted managed identites are also listed.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.get

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the managed identity to retrieve.

          Pattern : ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets an individual WorkloadIdentityPoolManagedIdentity.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.create

      Path : v1/{+parent}/managedIdentities

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent resource to create the manage identity in. The only supported location is `global`.

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

          Location : path

          Required : Yes

          Type : string

        workloadIdentityPoolManagedIdentityId

          Description : Required. The ID to use for the managed identity. This value must: * contain at most 63 characters * contain only lowercase alphanumeric characters or `-` * start with an alphanumeric character * end with an alphanumeric character The prefix "gcp-" will be reserved for future uses.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Creates a new WorkloadIdentityPoolManagedIdentity in a WorkloadIdentityPoolNamespace.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.patch

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Output only. The resource name of the managed identity.

          Pattern : ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Required. The list of fields to update.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates an existing WorkloadIdentityPoolManagedIdentity in a WorkloadIdentityPoolNamespace.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.delete

      Path : v1/{+name}

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the managed identity to delete.

          Pattern : ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes a WorkloadIdentityPoolManagedIdentity. You can undelete a managed identity for 30 days. After 30 days, deletion is permanent.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.undelete

      Path : v1/{+name}:undelete

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:undelete

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the managed identity to undelete.

          Pattern : ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Undeletes a WorkloadIdentityPoolManagedIdentity, as long as it was deleted fewer than 30 days ago.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.addAttestationRule

      Path : v1/{+resource}:addAttestationRule

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:addAttestationRule

      HTTP Method : POST

      Parameters :

        resource

          Description : Required. The resource name of the managed identity or namespace resource to add an attestation rule to.

          Pattern : ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Add an AttestationRule on a WorkloadIdentityPoolManagedIdentity. The total attestation rules after addition must not exceed 50.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.removeAttestationRule

      Path : v1/{+resource}:removeAttestationRule

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:removeAttestationRule

      HTTP Method : POST

      Parameters :

        resource

          Description : Required. The resource name of the managed identity or namespace resource to remove an attestation rule from.

          Pattern : ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Remove an AttestationRule on a WorkloadIdentityPoolManagedIdentity.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.setAttestationRules

      Path : v1/{+resource}:setAttestationRules

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:setAttestationRules

      HTTP Method : POST

      Parameters :

        resource

          Description : Required. The resource name of the managed identity or namespace resource to add an attestation rule to.

          Pattern : ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : resource

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

      Description : Set all AttestationRule on a WorkloadIdentityPoolManagedIdentity. A maximum of 50 AttestationRules can be set.

  • iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.listAttestationRules

      Path : v1/{+resource}:listAttestationRules

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}:listAttestationRules

      HTTP Method : GET

      Parameters :

        resource

          Description : Required. The resource name of the managed identity or namespace resource to list attestation rules of.

          Pattern : ^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : Optional. A query filter. Supports the following function: * `container_ids()`: Returns only the AttestationRules under the specific container ids. The function expects a comma-delimited list with only project numbers and must use the format `projects/`. For example: `container_ids(projects/, projects/,...)`.

          Location : query

          Type : string

        pageSize

          Description : Optional. The maximum number of AttestationRules to return. If unspecified, at most 50 AttestationRules are returned. The maximum value is 100; values above 100 are truncated to 100.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. A page token, received from a previous `ListWorkloadIdentityPoolProviderKeys` call. Provide this to retrieve the subsequent page.

          Location : query

          Type : string

      Parameter Order : resource

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

      Description : List all AttestationRule on a WorkloadIdentityPoolManagedIdentity.