Access resources from Microsoft Azure

This document shows you how to use identity federation to access Google Cloud resources from Microsoft Azure.

Traditionally, applications running outside Google Cloud have used service account keys to access Google Cloud resources. Using identity federation, you can let a managed identity for an Azure resource impersonate a service account. This lets your workload access Google Cloud resources directly, using a short-lived access token, and eliminates the maintenance and security burden associated with service account keys.

Before you begin

  1. Enable the IAM, Resource Manager, Service Account Credentials, and Security Token Service (STS) APIs.

    Enable the APIs

  2. Ensure that you have the Workload Identity Pool Admin (roles/iam.workloadIdentityPoolAdmin) and Service Account Admin (roles/iam.serviceAccountAdmin) roles on the project.

    Alternatively, the IAM Owner (roles/owner) basic role also includes permissions to configure identity federation. You should not grant basic roles in a production environment, but you can grant them in a development or test environment.

  3. Update the organization policy for your organization to allow federation from Azure.

  4. Create a Google Cloud service account.

  5. Grant the service account access to call the Google Cloud APIs required by your workload.

Identity provider settings for Azure

When you add Azure as an identity provider for your workload identity pool, you must provide the following:

  • An ID for the provider.

  • Your Azure Tenant ID.

  • A list of attribute mappings that map the claims on a token for an Azure-managed identity to the attributes on a Google token. Use assertion to refer to the Azure token, google for Google attributes, and attribute for custom attributes.

    There are two Google attributes: google.subject and google.groups. You can reference these attributes in IAM role bindings. google.subject also appears in Cloud Logging log entries.

    You must provide a mapping for google.subject. In general, we recommend mapping it to assertion.sub, which contains the object ID of a managed identity that you'll create in the next section. This provides a stable identifier for use in IAM role bindings. The mapping looks like this:

    google.subject=assertion.sub
    

    For more complex assertions, you can use the Common Expression Language. For example, if your workload identity pool contains multiple identity providers, you can append a prefix to disambiguate between them:

    google.subject="azure::" + assertion.tid + "::" + assertion.sub
    

    The google.subject field cannot exceed 127 characters.

    You can also specify custom attributes. For example, the following maps assertion.tid to attribute.tid:

    attribute.tid=assertion.tid
    

    The following example assigns a display name based on the value of assertion.oid:

    attribute.managed_identity_name={
    "8bb39bdb-1cc5-4447-b7db-a19e920eb111":"workload1",
    "55d36609-9bcf-48e0-a366-a3cf19027d2a":"workload2"
    }[assertion.oid]
    

    To obtain a complete list of claims you can reference, get an access token for an Azure VM in your workload. In your request, replace the resource parameter with the full resource name of your workload identity pool.

    For example:

    curl

    curl -s \
      'http://169.254.169.254/metadata/identity/oauth2/token?api-version=2018-02-01&resource=https://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID&object_id=MANAGED_IDENTITY_OBJECT_ID' \
      -H Metadata:true -H "Cache-Control: no-cache"
    

    PowerShell

    Invoke-WebRequest \
        -Uri 'http://169.254.169.254/metadata/identity/oauth2/token?api-version=2018-02-01&resource=https://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID&object_id=MANAGED_IDENTITY_OBJECT_ID' \
        -Headers @{Metadata="true"}
    

    The response is a JSON object with an access_token field, which contains an access token for the Azure VM. To decode the access token and view the available claims, follow these steps:

    1. Copy the entire access token.
    2. In a web browser, go to https://jwt.ms/.
    3. Paste the access token into the text box.
    4. Click Claims.

    To refer to a specific part of a claim in an expression, use the CEL extract() function, which extracts a value from a claim based on a template you provide. To learn more about extract(), see Extracting values from attributes.

    To check if a credential contains an claim, use the has() function.

Optionally, you can also provide the following:

  • A display name and description.

  • An attribute condition specifying attributes that the principal must present. The attribute condition can apply to claims on the Azure credential, or attributes on the Google credential. Any request that does not meet the attribute condition is rejected.

    Attribute conditions are formatted as a CEL expression that returns a boolean. For example, the following rejects requests from any identity that isn't a member of a specific group:

    "e968c2ef-047c-498d-8d79-16ca1b61e77e" in assertion.groups
    

    To learn more about common use cases, see Attribute conditions.

Create a workload identity pool and provider

You use a workload identity pool to organize and manage external identities. Workload identity pools are isolated from each other, but a single pool can impersonate any number of service accounts. In general, we recommend creating a new pool for each of your environments, such as development, staging, or production.

To create a new workload identity pool, you'll need to provide an ID. You can also provide an optional description and display name. The ID cannot begin with gcp-; this prefix is reserved for use by Google.

After you create the workload identity pool, you can add a workload identity pool provider. Each workload identity pool provider represents a specific identity provider, such as Azure. A single pool can contain multiple providers. To create the provider, you'll need the information described on this page in Identity provider settings for Azure.

Console

  1. In the Cloud Console, go to the New workload provider and pool page.

    Go to New workload provider and pool

  2. Enter a name for the workload identity pool.

    The Cloud Console uses the name to create a pool ID. To change the pool ID, click Edit. You cannot change the pool ID later.

  3. Optional: Enter a description for the workload identity pool.

  4. Click Continue.

  5. In the Select a provider drop-down list, select OpenID Connect (OIDC), then click Continue.

  6. Enter a provider name.

    The Cloud Console uses the name to create a provider ID. To change the provider ID, click Edit. You cannot change the provider ID later.

  7. Enter the issuer URL, then click Continue.

    For Azure, the issuer URL uses the format https://sts.windows.net/AZURE_TENANT_ID.

  8. To configure the attribute mapping, click Edit mapping.

    Attribute mapping lets you use information about external identities to grant access to a subset of those identities. For Azure, we recommend mapping google.subject to assertion.sub. Other mappings are optional.

    For details, see Identity provider settings for Azure on this page.

  9. Optional: To provide an attribute condition, which specifies the identities that can authenticate, click Add condition and enter a valid Common Expression Language (CEL) expression. For details, see Attribute conditions.

  10. Click Save to create the workload identity pool and provider.

gcloud

To create a workload identity pool, use the gcloud iam workload-identity-pools create command:

gcloud iam workload-identity-pools create POOL_ID \
    --location="global" \
    --description="DESCRIPTION" \
    --display-name="DISPLAY_NAME"

The response looks like:

Created workload identity pool [POOL_ID].

To add a workload identity pool provider, use the gcloud iam workload-identity-pools providers create-oidc command:

gcloud iam workload-identity-pools providers create-oidc PROVIDER_ID \
    --workload-identity-pool="POOL_ID" \
    --issuer-uri="https://sts.windows.net/AZURE_TENANT_ID" \
    --location="global" \
    --attribute-mapping="google.subject=assertion.sub"

The response looks like:

Created workload identity pool provider [PROVIDER_ID].

REST

To create a workload identity pool, do the following:

The projects.locations.workloadIdentityPools.providers.create method adds Azure as a provider.

HTTP method and URL:

POST https://iam.googleapis.com/v1/projects/project-id/locations/global/workloadIdentityPools/pool-id/providers?workloadIdentityPoolProviderId=provider-id

Request JSON body:

{
  "attributeMapping": {
    "google.subject": "assertion.sub"
  },
  "oidc": {
    "issuerUri": "https://sts.windows.net/azure-tenant-id"
  }
}

To send your request, expand one of these options:

The method returns a long-running Operation similar to the following:

{
  "name": "projects/project-number/locations/global/workloadIdentityPools/pool-id/providers/provider-id/operations/operation-id"
}

To add a workload identity pool provider, do the following:

The projects.locations.workloadIdentityPools.create method creates a workload identity pool.

HTTP method and URL:

POST https://iam.googleapis.com/v1/projects/project-id/locations/global/workloadIdentityPools?workloadIdentityPoolId=pool-id

Request JSON body:

{
  "description": "description",
  "display-name": "display-name"
}

To send your request, expand one of these options:

The method returns a long-running Operation similar to the following:

{
  "name": "projects/project-number/locations/global/workloadIdentityPools/pool-id/operations/operation-id"
}

Configure your Azure tenant for identity federation

To prepare your Azure tenant for identity federation:

  1. Create an Azure AD application and service principal, and set its Application ID URI to the full resource name of the provider you created in the previous section:

    https://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID
    
  2. Create a managed identity, and take note of its object ID.

  3. Assign the managed identity to a virtual machine that you want to grant access to Google Cloud resources.

Allow external identities to impersonate a service account

External identities can't access most Google Cloud resources directly. Instead, you let the identities impersonate a service account by granting them the Workload Identity User role (roles/iam.workloadIdentityUser) on the service account. When the external identities impersonate a service account, they have the same roles and permissions as the service account.

To grant the Workload Identity User role to Azure identities, do the following:

Console

Before you grant the Workload Identity User role, decide which identities you will allow to impersonate the service account. You can grant the role to all identities in the workload identity pool, or to a subset of these identities based on attribute mapping:

Identities Attribute name Attribute value
A specific managed identity subject MANAGED_IDENTITY_OBJECT_ID
All Azure identities in the given Azure tenant group AZURE_TENANT_ID
All identities with a specific attribute value ATTRIBUTE_NAME ATTRIBUTE_VALUE

Then grant access to the service account, and optionally, download a configuration file for generating credentials automatically:

  1. In the Cloud Console, go to the Workload Identity Pools page.

    Go to Workload Identity Pools

  2. Find the workload identity pool that contains the Azure identities, then click its Edit icon. The Cloud Console shows details about the workload identity pool.

  3. Click Grant access.

  4. In the Service account drop-down list, select the service account that the external identities will impersonate.

  5. Choose which identities in the pool can impersonate the service account.

    To allow all identities to impersonate the service account, select All identities in the pool.

    To allow a subset of identities to impersonate the service account, select Only identities matching the filter, then do the following:

    1. In the Attribute name drop-down list, select the attribute that you want to evaluate.

      Only mapped attributes appear on the list. The google. and attribute. prefixes are not shown.

    2. In the Attribute value field, enter the expected value of the attribute.

  6. Click Save.

    If the identities already had access to the service account, the Cloud Console shows details about the workload identity pool. You can skip the remaining steps.

    If the identities gained access to the service account, the Cloud Console shows the Configure your application dialog.

  7. Optional: To download a configuration file for generating credentials automatically, do the following:

    1. In the Provider drop-down list, select the provider that contains the Azure identities that will impersonate the service account.

    2. Click Download config to download a JSON configuration file.

  8. Click Dismiss.

gcloud

Before you grant the Workload Identity User role, decide which identities you will allow to impersonate the service account. You can grant the role to all identities in the workload identity pool, or to a subset of these identities based on attribute mapping:

Identities Member format
A specific managed identity principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/MANAGED_IDENTITY_OBJECT_ID
All Azure identities in the given Azure tenant principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/group/AZURE_TENANT_ID
All identities with a specific attribute value principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/attribute.ATTRIBUTE_NAME/ATTRIBUTE_VALUE
All identities in a pool principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/*

Then run the gcloud iam service-accounts add-iam-policy-binding command:

gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
    --role=roles/iam.workloadIdentityUser \
    --member="MEMBER"

Replace the following values:

  • SERVICE_ACCOUNT_EMAIL: The email address for the service account.
  • MEMBER: The external identities that will impersonate the service account.

REST

Before you grant the Workload Identity User role, decide which identities you will allow to impersonate the service account. You can grant the role to all identities in the workload identity pool, or to a subset of these identities based on attribute mapping:

Identities Member format
A specific managed identity principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/MANAGED_IDENTITY_OBJECT_ID
All Azure identities in the given Azure tenant principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/group/AZURE_TENANT_ID
All identities with a specific attribute value principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/attribute.ATTRIBUTE_NAME/ATTRIBUTE_VALUE
All identities in a pool principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/*

Then use the read-modify-write pattern to update the policy:

  1. Read the service account's current IAM policy.
  2. Modify the policy to grant the role.
  3. Write the updated policy.

Read the service account's IAM policy.

The serviceAccounts.getIamPolicy method gets a service account's IAM policy.

Before using any of the request data below, make the following replacements:

  • PROJECT_ID: Your Google Cloud project ID. Project IDs are alphanumeric strings, like my-project.
  • SA_ID: The ID of your service account. This can either be the service account's email address in the form SA_NAME@PROJECT_ID.iam.gserviceaccount.com, or the service account's unique numeric ID.

  • POLICY_VERSION: The policy version to be returned. Requests should specify the most recent policy version, which is policy version 3. See Specifying a policy version when getting a policy for details.

HTTP method and URL:

POST https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts/SA_ID:getIamPolicy

Request JSON body:

{
  "options": {
    "requestedPolicyVersion": POLICY_VERSION
  }
}

To send your request, expand one of these options:

You should receive a JSON response similar to the following:

{
  "version": 1,
  "etag": "BwWKmjvelug=",
  "bindings": [
    {
      "role": "roles/serviceAccountAdmin",
      "members": [
        "user:admin@example.com"
      ]
    }
  ]
}

When there is no existing policy, the response contains only the default etag. If you get this response, add a version field, set to 3, and a bindings field, set to an empty array.

Modify the policy to grant the appropriate roles to your members.

To grant a role, you modify the bindings array from the response body:

  • If a binding for the role does not exist, add a new object to the bindings array that defines the role you want to grant and the member you want to grant it to.
  • If a binding already exists for the role, add the new member to the list of existing members.

Example:

To grant the Workload Identity User role (roles/iam.workloadIdentityUser) to all identities in the pool, change the example shown in the previous step as follows:

{
  "version": 1,
  "etag": "BwUqLaVeua8=",
  "bindings": [
    {
      "role": "roles/iam.workloadIdentityUser",
      "members": [
        "principalSet://iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/*"
      ]
    },
    {
      "role": "roles/iam.serviceAccountAdmin",
      "members": [
        "user:admin@example.com"
      ]
    }
  ]
}

Write the updated policy.

The serviceAccounts.setIamPolicy method sets an updated IAM policy for the service account.

Before using any of the request data below, make the following replacements:

  • PROJECT_ID: Your Google Cloud project ID. Project IDs are alphanumeric strings, like my-project.
  • SA_ID: The ID of your service account. This can either be the service account's email address in the form SA_NAME@PROJECT_ID.iam.gserviceaccount.com, or the service account's unique numeric ID.

  • POLICY: A JSON representation of the policy that you want to set. For more information about the format of a policy, see the Policy reference.

    For example, to set the policy shown in the previous step, replace policy with the following:

    {
      "version": 1,
      "etag": "BwUqLaVeua8=",
      "bindings": [
        {
          "role": "roles/iam.workloadIdentityUser",
          "members": [
            "principalSet://iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/*"
          ]
        },
        {
          "role": "roles/iam.serviceAccountAdmin",
          "members": [
            "user:admin@example.com"
          ]
        }
      ]
    }
    

HTTP method and URL:

POST https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts/SA_ID:setIamPolicy

Request JSON body:

{
  "policy": POLICY
}

To send your request, expand one of these options:

The response contains the updated policy.

Generate Google credentials

If you use a supported client library, you can configure the client library so that it generates Google credentials automatically. Alternatively, you can generate Azure credentials manually, then exchange them for Google credentials.

When possible, we recommend that you generate credentials automatically, so that you do not need to implement the token-exchange process yourself.

Automatically generate credentials

If you access Google Cloud with a client library for one of the following languages, you can configure the client library to automatically generate credentials by using identity federation:

C++

Most of the Google Cloud Client Libraries for C++ support identity federation by using a ChannelCredentials object, which is created by calling grpc::GoogleDefaultCredentials(). To initialize this credential, you must build the client libraries with version 1.36.0 or later of gRPC.

The Cloud Storage Client Library for C++ uses the REST API, not gRPC, so it does not support identity federation.

Go

Client libraries for Go support identity federation if they use version v0.0.0-20210218202405-ba52d332ba99 or later of the golang.org/x/oauth2 module.

To check which version of this module your client library uses, run the following commands:

cd $GOPATH/src/cloud.google.com/go
go list -m golang.org/x/oauth2

Java

Client libraries for Java support identity federation if they use version 0.24.0 or later of the com.google.auth:google-auth-library-oauth2-http artifact.

To check which version of this artifact your client library uses, run the following Maven command in your application directory:

mvn dependency:list -DincludeArtifactIds=google-auth-library-oauth2-http

Node.js

Client libraries for Node.js support identity federation if they use version 7.0.2 or later of the google-auth-library package.

To check which version of this package your client library uses, run the following command in your application directory:

npm list google-auth-library

When you create a GoogleAuth object, you can specify a project ID, or you can allow GoogleAuth to find the project ID automatically. To find the project ID automatically, the service account in the configuration file must have the Browser role (roles/browser), or a role with equivalent permissions, on your project. For details, see the README for the google-auth-library package.

Python

Client libraries for Python support identity federation if they use version 1.27.0 or later of the google-auth package.

To check which version of this package your client library uses, run the following command in the environment where the package is installed:

pip show google-auth

To specify a project ID for the authentication client, you can set the GOOGLE_CLOUD_PROJECT environment variable, or you can allow the client to find the project ID automatically. To find the project ID automatically, the service account in the configuration file must have the Browser role (roles/browser), or a role with equivalent permissions, on your project. For details, see the user guide for the google-auth package.

To configure the client library to generate credentials automatically, you create a JSON configuration file. You can create this file with the Cloud Console or the gcloud tool.

Console

First, follow the instructions on this page to allow external identities to impersonate a service account. You can then create a JSON configuration file for any service account that the external identities can impersonate.

To create a JSON configuration file, do the following:

  1. In the Cloud Console, go to the Workload Identity Pools page.

    Go to Workload Identity Pools

  2. Find the workload identity pool that contains the identity provider you want to use, then click its Edit icon. The Cloud Console shows details about the workload identity pool.
  3. Click Connected service accounts.
  4. Find the service account you want to use, then click Download.
  5. In the Provider drop-down list, select the provider that contains the Azure identities that will impersonate the service account.
  6. Click Download config to download the JSON configuration file, then click Done.

gcloud

To create a JSON configuration file, run the gcloud iam workload-identity-pools create-cred-config command:

gcloud iam workload-identity-pools create-cred-config \
    projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID \
    --service-account=SERVICE_ACCOUNT_EMAIL \
    --output-file=FILEPATH \
    --azure

Replace the following values:

  • PROJECT_NUMBER: The numeric ID for the project.
  • POOL_ID: The ID for the workload identity pool.
  • PROVIDER_ID: The ID for the workload identity pool provider.
  • SERVICE_ACCOUNT_EMAIL: The email address of the service account to impersonate.
  • FILEPATH: The filepath for the configuration file.

After you generate the configuration file, set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the filepath for the configuration file. This environment variable tells the client library to use Application Default Credentials to authenticate. For details, see Finding credentials automatically.

Manually exchange credentials

Once your Azure-managed identity has the ability to impersonate a service account, you can manually exchange its credentials for Google credentials.

To exchange credentials:

  1. Use the Azure Instance Metadata Service (IMDS) to obtain an Azure access token.

    Set the resource query parameter to the following value:

    https://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID
    

    Set the object_id query parameter to the object ID for the managed identity that you created earlier.

  2. Pass the Azure access token to the Security Token Service token() method to get a federated access token:

    REST

    The token method exchanges a third-party token for a Google token.

    Before using any of the request data below, make the following replacements:

    • PROJECT_NUMBER: Your Google Cloud project number.
    • POOL_ID: The ID of the workload identity pool you created.
    • PROVIDER_ID: The ID of the identity provider you configured.
    • ID_TOKEN: The token from the identity provider.

    HTTP method and URL:

    POST https://sts.googleapis.com/v1/token

    Request JSON body:

    {
      "audience": "//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID",
      "grantType": "urn:ietf:params:oauth:grant-type:token-exchange",
      "requestedTokenType": "urn:ietf:params:oauth:token-type:access_token",
      "scope": "https://www.googleapis.com/auth/cloud-platform",
      "subjectTokenType": "urn:ietf:params:oauth:token-type:jwt",
      "subjectToken": "ID_TOKEN"
    }
    

    To send your request, expand one of these options:

     

    The method returns a federated token.

  3. Call generateAccessToken() to exchange the federated token for a service account access token. A limited number of Google Cloud APIs support federated tokens; all Google Cloud APIs support service account access tokens.

    REST

    The Service Account Credentials API's serviceAccounts.generateAccessToken method generates an OAuth 2.0 access token for a service account.

    Before using any of the request data below, make the following replacements:

    • PROJECT_ID: Your Google Cloud project ID. Project IDs are alphanumeric strings, like my-project.
    • SA_ID: The ID of your service account. This can either be the service account's email address in the form SA_NAME@PROJECT_ID.iam.gserviceaccount.com, or the service account's unique numeric ID.
    • token: The federated access token.

    HTTP method and URL:

    POST https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/SA_NAME@PROJECT_ID.iam.gserviceaccount.com:generateAccessToken

    Request JSON body:

    {
      "scope": [
        "https://www.googleapis.com/auth/cloud-platform"
      ]
    }
    

    To send your request, expand one of these options:

    If the generateAccessToken request was successful, the response body contains an OAuth 2.0 access token and an expiration time. The accessToken can then be used to authenticate a request on behalf of the service account until the expireTime has been reached:

    {
      "accessToken": "eyJ0eXAi...NiJ9",
      "expireTime": "2020-04-07T15:01:23.045123456Z"
    }
    

Once you have an access token for a service account, you can use it to call Google Cloud APIs by including the token in the Authorization header of your requests:

Authorization: Bearer SERVICE_ACCOUNT_ACCESS_TOKEN

The request is authorized as the service account.

What's next