The Google APIs Client Library for Ruby supports using OAuth 2.0 for server-to-server interactions such as those between a web application and a Google service. For this scenario you need a service account, which is an account that belongs to your application instead of to an individual end user. Your application calls Google APIs on behalf of the service account, so users aren't directly involved. This scenario is sometimes called "two-legged OAuth," or "2LO." (The related term "three-legged OAuth" refers to scenarios in which your application calls Google APIs on behalf of end users, and in which user consent is sometimes required.)
Typically, an application uses a service account when the application uses Google APIs to work with its own data rather than a user's data. For example, an application that uses Google Cloud Datastore for data persistence would use a service account to authenticate its calls to the Google Cloud Datastore API.
If you have a Google Apps domain—if you use Google Apps for Work, for example—an administrator of the Google Apps domain can authorize an application to access user data on behalf of users in the Google Apps domain. For example, an application that uses the Google Calendar API to add events to the calendars of all users in a Google Apps domain would use a service account to access the Google Calendar API on behalf of users. Authorizing a service account to access data on behalf of users in a domain is sometimes referred to as "delegating domain-wide authority" to a service account.
This document describes how an application can complete the server-to-server OAuth 2.0 flow by using the Google APIs Client Library for Ruby.
To support server-to-server interactions, first create a service account for your project in the Developers Console. If you want to access user data for users in your Google Apps domain, then delegate domain-wide access to the service account.
Then, your application prepares to make authorized API calls by using the service account's credentials to request an access token from the OAuth 2.0 auth server.
Finally, your application can use the access token to call Google APIs.
Creating a service account
A service account's credentials include a generated email address that is unique, a client ID, and at least one public/private key pair.
If your application runs on Google App Engine, a service account is set up automatically when you create your project.
If your application runs on Google Compute Engine, a service account is also set up automatically when you create your project, but you must specify the scopes that your application needs access to when you create a Google Compute Engine instance. For more information, see Preparing an instance to use service accounts.
If your application doesn't run on Google App Engine or Google Compute Engine, you must obtain these credentials in the Google Developers Console. To generate service-account credentials, or to view the public credentials that you've already generated, do the following:
- Go to the Google Developers Console.
- Select a project, or create a new one.
- In the sidebar on the left, expand APIs & auth. Next, click APIs. Select the Enabled APIs link in the API section to see a list of all your enabled APIs. Make sure that the API is on the list of enabled APIs. If you have not enabled it, select the API from the list of APIs, then select the Enable API button for the API.
- In the sidebar on the left, select Credentials.
To set up a new service account, do the following:
- Under the OAuth heading, select Create new Client ID.
- When prompted, select Service Account and click Create Client ID.
- A dialog box appears. To proceed, click Okay, got it.
Your new Public/Private key pair is generated and downloaded to your machine; it serves as the only copy of this key. You are responsible for storing it securely. The Console shows your private key's password only at this initial moment of service account creation--the password will not be shown again. You now have Generate New JSON Key and Generate New P12 Key options, and the ability to delete.
You can return to the Developers Console at any time to view the client ID, email address, and public key fingerprints, or to generate additional public/private key pairs. For more details about service account credentials in the Developers Console, see Service accounts in the Developers Console help file.
Take note of the service account's email address and store the service account's P12 private key file in a location accessible to your application. Your application needs them to make authorized API calls.
Delegating domain-wide authority to the service account
If your application runs in a Google Apps domain and accesses user data, the service account that you created needs to be granted access to the user data that you want to access.
The following steps must be performed by an administrator of the Google Apps domain:
- Go to your Google Apps domain’s Admin console.
- Select Security from the list of controls. If you don't see Security listed, select More controls from the gray bar at the bottom of the page, then select Security from the list of controls. If you can't see the controls, make sure you're signed in as an administrator for the domain.
- Select Advanced settings from the list of options.
- Select Manage third party OAuth Client access in the Authentication section.
- In the Client name field enter the service account's Client ID.
- In the One or More API Scopes field enter the list of scopes that your application should be granted access to. For example, if your application needs domain-wide access to the Google Drive API and the Google Calendar API, enter: https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/calendar.
- Click Authorize.
Your application now has the authority to make API calls as users in your domain (to "impersonate" users). When you prepare to make authorized API calls, you specify the user to impersonate.
Preparing to make an authorized API call
After you obtain the client email address and private key from the Developers Console, complete the following steps:
Clientobject from the service account's credentials and the scopes your application needs access to. For example:
require 'googleauth' require 'google/apis/compute_v1' compute = Google::Apis::ComputeV1::ComputeService.new # Get the environment configured authorization scopes = ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/compute'] compute.authorization = Google::Auth.get_application_default(scopes)
If you have delegated domain-wide access to the service account and you want to impersonate a user account, specify the email address of the user account in the
:subparameter. For example:
require 'googleauth' require 'google/apis/sqladmin_v1beta4' # Get the environment configured authorization scopes = ['https://www.googleapis.com/auth/sqlservice.admin'] authorization = Google::Auth.get_application_default(scopes) # Clone and set the subject auth_client = authorization.dup auth_client.sub = 'email@example.com'
- Use the
fetch_access_token!method of the
clientobject to acquire an access token. For example:
Use the authorized
Client object to call Google APIs in
Calling Google APIs
Use the authorized
Client object to call Google APIs by
completing the following steps:
- Build a service object for the API that you want to call. You build a
a service object by calling the
discovered_apimethod of an
APIClientobject with the name and version of the API. For example, to call version 1beta3 of the Cloud SQL Administration API:
sqladmin = Google::Apis::SqladminV1beta4::SqladminService.new sqladmin.authorization = auth_client
- Make requests to the API service using the
provided by the service object, and providing the authorized
Clientobject. For example, to list the instances of Cloud SQL databases in the examinable-example-123 project:
instances = sqladmin.list_instances('examinable-example-123')
The following example prints a JSON-formatted list of Cloud SQL instances in a project.
require 'googleauth' require 'google/apis/sqladmin_v1beta4' sqladmin = Google::Apis::SqladminV1beta4::SqladminService.new # Get the environment configured authorization scopes = ['https://www.googleapis.com/auth/sqlservice.admin'] sqladmin.authorization = Google::Auth.get_application_default(scopes) instances = sqladmin.list_instances('examinable-example-123') puts instances.to_h