Skip to main content

April 17, 2025 Archived

Add an OAuth 2.0 User Access Token Client to Omnissa Access

To enable a single application to register with Omnissa Access services to allow user access the application, create a user access token client.

Registering the details of the application identifies the application as a trusted client for the OAuth service.

You register the client ID, client secret, and redirect URI with Omnissa Access service.

Procedure

  1. In the Omnissa Access console Settings > OAuth 2.0 Management page, click ADD CLIENT.

  2. In the Add Client page, configure the following.

    LabelDescription
    Access TypeOptions are to create either a User Access Token or a Service Client Token. Set to User Access Token.
    Client IDEnter a unique client identifier for the application. The client ID is used to authenticate to Omnissa Access. The client id must not match any client id in your tenant. The following characters can be used, alphanumeric (A-Z, a-z, 0-9) period (.), underscore (_), and hyphen (-) and at sign (@), and no more than 256 characters long.
    Grant TypeSelect one or more of the following grant types.
    • Client Credentials Grant
    • Password Grant
    • Authorization Code Grant. When you select Authorization Code Grant, the Redirect URI setting is displayed under Grant Type.
    • Refresh Token Grant is enabled by default when the Issue refresh token setting is enabled. If you deactivate Issue refresh token, the Refresh Token Grant type is not checked.
    Redirect URIEnter the registered redirect URI for Authorization Code Grant. Enter as https://redirecturi.com.
    You can use a comma separated list to add more than one redirect URL.
    ScopeThe scope defines which part of the user's account the token can access. The scopes you can select from include Email, Profile, User, NAPPS, OpenID, Group, and Admin. Select one or more identity scopes that you want as part of the OAuth 2.0 authorization request. When you select Admin, the Admin Roles setting is displayed.
    Admin RolesWhen you select the Admin setting in Scope, in the drop-down menu, select the admin roles granted to the admin.
    Issue refresh token To allow for the return of a refresh token, leave this option enabled.
    Refresh token TTLSet the Refresh Token time to live value. New access tokens can be requested until the refresh token expires. See Managing OAuth 2.0 Clients in Omnissa Access.
    Access token TTLThe access token expires in the number of seconds set in Access Token TTL. If Issue Refresh Token is enabled, when the access token expires, the application uses the refresh token to request a new access token.
    Idle Token TTLConfigure how long a refresh token can be idle before it cannot be used again.
    Token TypeFor Omnissa Access, the token type is Bearer Token.
    User GrantPrompt users for scope acceptance is enabled. Users are shown a message that lists the scopes that are being sent.
  3. Click SAVE.

    The client page is refreshed and the Client ID and the hidden Shared Secret are displayed.

  4. Copy and save the client ID and generated shared secret. You add this information when you configure the application.

    The client secret must be kept confidential. If a deployed app cannot keep the secret confidential, then the secret is not used. The shared secret is not used with Web browser-based applications.

    Note: The shared secret is not saved. If you lose the secret code, you must generate a new secret, and update the app that uses the same shared secret with the regenerated secret.

    To regenerate a secret, click the client ID that requires a new secret from the OAuth 2.0 Management page and click REGENERATE SECRET.

What to do next

In the resource application, configure the client ID and the generated shared secret. See the application documentation.

Was this page helpful?

Provide feedback for this topic

Was this topic helpful?

Please do not include any personal or confidential information.

Generating link…