Managing Cloud Services Accounts

Your Omnissa Cloud Services account is where you manage your user profile. Select security settings and generate and manage API tokens. You can also view the roles you hold in your Organization.

To access your account, click your user name, and then click My Account.

How do I view my user profile

Your user profile consists of the details you provided when you created your Omnissa customer account.

Note: You cannot change the email address with which you registered. You can view your user profile in https://customerconnect.omnissa.com.

How do I generate API tokens

You use API tokens to authenticate yourself when you make authorized API connections. Previously called an OAuth Refresh token, an API token is exchanged for an access token and authorizes access per Organization. You generate API tokens from your account page in Cloud Services Console or through the Omnissa Cloud Services.

Tokens are generated using a special algorithm that picks up alphanumeric characters. Each token is a unique 65 characters combination. When you generate a token, you determine its duration and scopes:

A token's Time to Live (TTL) can range from several minutes to several months, or set to never expire. The default duration is six months.
Scopes provide a way to implement control over what areas in an Organization your token can access - specifically which role in an Organization, and what services and the level of permissions.

Prerequisites

Ensure a secure and protected storage location for your API tokens.

Procedure

Notes:

A non-expiring token can be a security risk if compromised. If this happens, you must revoke the token.
Even if you assign All Roles access to your token, it will have only those access roles which your user account supports. To view the Organization and service roles you have, from the My Account page select the My Roles tab.

On the Cloud Services Console toolbar, click your user name and select My Account > API Tokens.
Click the Generate a New API Token link.
Enter a name for the token.
Specify the desired lifespan of the token.
Define scopes for the token. Your selection must be based on the roles supported by your user account.

Scope	Description
Organization Roles	Organization roles determine a user's access to the Organization's resources. Select one or more Organization roles for your API Token.
Service Roles	Service roles are built in pre-defined sets of permissions that grant access to Omnissa Cloud Services. Use the arrow icon next to a service name to expand the roles available for that service, then select one or more service roles for your API Token.
Permissions	Some services allow you make a more granular selection by assigning a limited set of the permissions available for a service role. When you select a service role, the available permissions are displayed in the right side of the table. Select the relevant service permissions for your API Token.

(Optional) Select the Open ID check box to retrieve an Open ID compliant token with extended user details.
(Optional) Set an email preference to receive a reminder when your token is about to expire.
Click Generate.
Save the token credentials to a safe place so you can retrieve them to use later on.
For security reasons, after you generate the token, we only display the name of the token on the API Tokens page and not the token credentials. This means that you will no longer be able to reuse the token by copying the credentials from this page.
Click Continue.
In addition to API tokens, you can use OAuth apps to authenticate your applications. To see when to use OAuth apps instead of API tokens

Example: Using an API Token to Interact with Omnissa Cloud Service APIs

You can use an API token to interact with our APIs by exchanging it for an authentication token.

Generate an API token.
Perform POST to https://connect.omnissa.com/csp/gateway/am/api/auth/api-tokens/authorize.
In the header, include the following requests:
- accept: application/json
- content type: application/x-www-form-urlencoded/
In the body, include the refresh_token={token value} request.
Use the authentication token in the csp-auth-token header in your script's HTTP calls.

How do I manage my API tokens

As the sole owner of your API tokens, it is your responsibility to securely store, backup and manage them.

To view and manage your API tokens, click your user name, then select My Account > API Tokens.

To regenerate a token, click Regenerate. This replaces the existing token with a new one. In order to continue calling the APIs, you must update your token in the API calls.
To deactivate a token, click Revoke. This revokes both the API token and the associated access token.
To prevent unauthorized access to your Organization's resources, it is strongly recommended that you keep the API tokens you generate in a secure and protected location. Omnissa Cloud Services does not check for proof of possession, but captures token usage audit events when:
- a user generates an API token
- a user revokes one or all personal tokens
- a user makes an unsuccessful attempt to generate access token by API token refresh
  Note: To view the audit event logs in Omnissa Cloud Services, you must have an Organization Owner role.
To add an extra layer of security to your APIs, you can add Multi-Factor Authentication for your API tokens. For more information, see .
If your API token has been deactivated by an Organization Owner for violating any policy set in the Organization, or for not adhering to the Organization's standards, you will receive an email notification from Omnissa Cloud Services. On your My Account > API Tokens page, deactivated tokens are marked with the label The label Deactivated appears next to the API Token name..

View a list of the most common API token self-service management tasks.

If you want to...	Do this...
Extend the validity of an API token that has expired.	You must regenerate your token.
Regenerate a valid API token.	You can regenerate a token at any time. If you regenerate a token, you revoke all instances of the previous token. If you have used the token, for example in one of your scripts, remember to replace it with the newly generated token.
Replace a compromised API token.	If you feel the token has been compromised, you can revoke the token to prevent unauthorized access. You generate a new token to renew authorization.
Destroy an API token that is still valid.	You destroy a valid API token by revoking it.
Recover a lost API token.	Lost tokens cannot be recovered. You must revoke the lost token and generate a new one.
Reactivate an API token deactivated by an Organization Owner	If a deactivated token is still valid, you must contact the Organization Owner and ask for its reactivation.

How do I manage my roles in an Organization

Roles are assigned by users with the Organization Owner role. You will typically hold a role in the Organization and a role in one or more of the Organization's services. As an Organization Member user, you can request additional service roles for services available in your Organization and you can delete roles already assigned to you. To obtain additional service role access, your request must be approved by an Organization Owner.

Here's how you manage your service roles in the Organization:

To view your roles, see what access you have to services, and request additional roles, click your user name, and select My Account > My Roles.
To delete a service role or an additional Organization role you no longer need, click the service name to expand all roles you have for that service. After locating the service role you want to remove, click Delete Role. In order to take effect, your role deletion request must be approved by an Organization Owner.
To view past role requests, scroll down to the My Request History section of the page.
To request additional service roles for services already available in your Organization, click Request Roles and make a selection.

Was this page helpful?