Cloud Platform API v2 authentication¶

Generating an API token¶

To generate an API token for authenticating with the Cloud Platform API v2:

1. Sign in to the Acquia Cloud Platform user interface using your email address and Acquia password.

2. Click your user avatar in the upper right corner, and then click Account Settings.

   

3. On the Profile page, click API Tokens.

4. Provide a human-readable label for your API token, and click Create Token.

   Cloud Platform will generate an API Key and API secret for you.

5. Record a copy of your API Key and API secret, as you can’t retrieve them after closing your browser tab.

You can remove a token at any time by clicking Remove next to the token you want to remove.

Authenticating in Cloud Platform API RESTful interface calls¶

Each Cloud Platform API call authenticates requests with OAuth 2.0 client credentials, and requires the information provided when generating an API token.

• Access Token URL: https://accounts.acquia.com/api/auth/oauth/token
• Client ID: The API Key provided to you when generating an API token
• Secret: The API Secret provided to you when generating an API token

The Client ID and Secret are exchanged for a bearer access token, which authenticates calls to the Cloud Platform API.

curl https://accounts.acquia.com/api/auth/oauth/token --data-urlencode "client_id=API_KEY" --data-urlencode "client_secret=API_SECRET" --data-urlencode "grant_type=client_credentials"

Making API Calls through Single Sign-On¶

If your organization uses Single Sign-On (SSO), you must use OAuth 2.0 and request the organization:uuid scope while generating the API token. The uuid is the UUID of the organization’s resources for which you want access.

Here is the example curl request:

curl \
--data-urlencode 'client_id=API TOKEN KEY HERE' \
--data-urlencode 'client_secret=API TOKEN SECRET HERE' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'scope=organization:23NNe327-NAAA-11e3-NNNN-1231NNNNa02c' \
-X POST \
'https://accounts.acquia.com/api/auth/oauth/token'