Authenticate to Dataform

This document describes how to authenticate to Dataform programmatically. How you authenticate to Dataform depends on the interface you use to access the API and the environment where your code is running.

For more information about Google Cloud authentication, see the authentication overview.

API access

Dataform supports programmatic access. You can access the API in the following ways:

Client libraries
REST

Client libraries

The Dataform client libraries provide high-level language support for authenticating to Dataform programmatically. To authenticate calls to Google Cloud APIs, client libraries support Application Default Credentials (ADC); the libraries look for credentials in a set of defined locations and use those credentials to authenticate requests to the API. With ADC, you can make credentials available to your application in a variety of environments, such as local development or production, without needing to modify your application code.

REST

You can authenticate to the Dataform API by using your gcloud CLI credentials or by using Application Default Credentials. For more information about authentication for REST requests, see Authenticate for using REST. For information about the types of credentials, see gcloud CLI credentials and ADC credentials.

Set up authentication for Dataform

How you set up authentication depends on the environment where your code is running.

The following options for setting up authentication are the most commonly used. For more options and information about authentication, see Authentication methods.

For a local development environment

You can set up credentials for a local development environment in the following ways:

User credentials for client libraries or third-party tools
User credentials for REST requests from the command line

Client libraries or third-party tools

Set up Application Default Credentials (ADC) in your local environment:

Install the Google Cloud CLI, then initialize it by running the following command:
```
gcloud init
```
If you're using a local shell, then create local authentication credentials for your user account:
```
gcloud auth application-default login
```
You don't need to do this if you're using Cloud Shell.

A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.

For more information about working with ADC in a local environment, see Local development environment.

REST requests from the command line

When you make a REST request from the command line, you can use your gcloud CLI credentials by including gcloud auth print-access-token as part of the command that sends the request.

The following example lists service accounts for the specified project. You can use the same pattern for any REST request.

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

PROJECT_ID: Your Google Cloud project ID.

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Execute the following command:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts"

PowerShell (Windows)

Execute the following command:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts" | Select-Object -Expand Content

For more information about authenticating using REST and gRPC, see Authenticate for using REST. For information about the difference between your local ADC credentials and your gcloud CLI credentials, see gcloud CLI authentication configuration and ADC configuration.

Access control for Dataform

After you authenticate to Dataform, you must be authorized to access Google Cloud resources. Dataform uses Identity and Access Management (IAM) for authorization.

For more information about the roles for Dataform, see Access control with IAM. For more information about IAM and authorization, see IAM overview.

What's next

Learn about Google Cloud authentication methods.
See a list of authentication use cases.