Authenticating to the Acronis platform

Important

To authenticate to the Acronis platform, you must have an activated administrator account.

By authenticating to the Acronis platform with an access token, the integration will have the right to perform operations in the tenant and its sub-tenants on behalf of the administrator.

To authenticate to the Acronis platform

1. [If not already started] Start the Python shell and configure its session.

   The requests, json, and pprint modules should be loaded in the interactive shell.

2. Register an API client in the tenant.

   1. Follow the procedures described in the Acronis Cyber Protect Cloud Partner’s Guide.

   2. Define variables client_id, client_secret and datacenter_url and assign the saved client ID, client secret, and data center URL data from the previous step to them:

      >>> client_id = '<your client ID>'
      >>> client_secret = '<your client secret>'
      >>> datacenter_url = '<your Acronis data center URL>'
      

      Note

      The Account Management API base URL is <your data center URL>/api/2.

   3. Define a variable base_url and assign the Account Management API base URL to it.

      >>> base_url = f'{datacenter_url}/api/2'
      

3. Issue an access token to the API client.

   1. Encode the client ID and client secret string using Base64 encoding, and store the result in a variable:

      >>> from base64 import b64encode  # Used for encoding to Base64
      >>> encoded_client_creds = b64encode(f'{client_id}:{client_secret}'.encode('ascii'))
      

   2. Define a variable named basic_auth, and then assign an object with the Authorization key containing authentication data to this variable:

      >>> basic_auth = {
      ...     'Authorization': 'Basic ' + encoded_client_creds.decode('ascii')
      ... }
      

   3. Send a POST request to the /idp/token endpoint. The request should contain authentication data in the request headers and contain the grant_type field set to client_credentials in its body:

      >>> response = requests.post(
      ...     f'{base_url}/idp/token',
      ...     headers={'Content-Type': 'application/x-www-form-urlencoded', **basic_auth},
      ...     data={'grant_type': 'client_credentials'},
      ... )
      

   4. Check the status code of the response:

      >>> response.status_code
      200
      

      Status code 200 means that the platform has authenticated the API client and issued the API client a token for accessing API endpoints (an access token). The response body text contains an encoded JSON object with this token and some other information.

   5. Convert the JSON text that the response body contains to an object, and then store this object in a variable named token_info:

      >>> token_info = response.json()
      >>> pprint.pprint(token_info)
      {'access_token': 'eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImMwMD...',
       'expires_on': 1562910964,
       'id_token': 'eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IjI5ZT...',
       'token_type': 'bearer'}
      

   6. Define a variable named auth, and then assign an object, that will be used for constructing an Authorization header in API requests, to this variable:

      >>> auth = {'Authorization': 'Bearer ' + token_info['access_token']}
      >>> auth
      {'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImMwMD...'}
      

      You will need to specify this variable in every request to the API as follows:

      requests.get(f'{base_url}/clients/{client_id}', headers=auth)

   7. In order to access an Acronis product API, update the base_url variable with the Acronis product API location:

      >>> base_url = f'{datacenter_url}/<product API location>'
      

      To find the appropriate Acronis API location, see Acronis product API locations reference.

   Your integration now has access to the appropriate Acronis product API.