Service Account and API Access

Cloud Access Manager provides direct API access in the Cloud Access Manager service. API's are an advanced way of interacting with the service, which enables you to integrate it into your business systems or to automate your use of the service for your specific needs.

Service Accounts: There are two types of service accounts that you can create with the Cloud Access Manager Admin Console:

CAM Service Accounts

The CAM service account is an account that is created from the Cloud Access Manager Admin Console for the purpose of creating future deployments and deployment service accounts through the Cloud Access Manager APIs. The CAM service account cannot perform any actions within a deployment, and so further actions to a deployment require the deployment service account, which is outlined below. For information on creating a CAM service account, see here.

Deployment Service Accounts

Deployment service accounts are specific accounts that can only perform actions against the deployment, such as adding remote workstations. The deployment in this case is the deployment the service account is created within. They cannot perform actions against any other deployment. For information on creating a deployment service account, see here.

API Access Token¶

The API Access Token can be used to enable a user to operate at a level above deployments, such as creating a new deployment. The API Access Token is only valid for a limited period of time. This token also acts as an authorization token that can be used when performing an account ownership transfer, as outlined here.

For more detailed information on accessing the Cloud Access Manager APIs, see https://cam.teradici.com/api/docs.

Creating a CAM Service Account¶

You can create a CAM service account from within the Cloud Access Manager Admin Console. The following steps outline how to create a CAM service account.

1. Click on your account name and select CAM service account.
2. Click the + icon from the CAM service account page and name your new account.
3. Once you have created the CAM service account download the JSON file or copy the key id. Ensure that you store the file securely as this key cannot be recovered if lost.
4. Go to the Service Account Keys section of the Cloud Access Manager API documentation for the required APIs to use this key to create a deployment.

Creating and Assigning a Deployment Service Account¶

You can create and assign a deployment service account to a deployment through the Deployments option within the Cloud Access Manager Admin Console. The following steps outline how to add a deployment service account to an existing deployment:

1. Click on your deployment from the console dropdown to display your existing deployments.
2. Click the kebab icon and click Edit deployment to display the deployment properties page.
3. Under the Deployment Service Accounts tab click the + sign to create a service account.
4. Once the service account has been created it will return service account information. This information should be saved as a JSON file in a secure location, as it can only be retrieved once. It will return a Cloud Access Manager API token that you can use to query the Cloud Access Manager APIs. This token is only authorized to access resources associated to the deployment that service account is associated with.

All deployment service accounts associated with a specific deployment will be listed on the deployment page. You can delete deployment service accounts from this page. For information on using the deployment service accounts and deployment service keys with the Cloud Access Manager APIs, see here.

Obtaining a Cloud Access Manager API Access Token¶

API access tokens permit you to enable other tools and applications to interact with Cloud Access Manager through public APIs. The access token has tenant level permissions, which enables you to access all of a user's resources from any deployment.

To obtain a Cloud Access Manager API Access token:

• Click Get API token from the user account icon within the Cloud Access Manager Admin Console. You will receive the following message:

You need to copy the token as it will expire after a period of time.