Getting an Access Token using Swagger Docs

Before you can request an access token, you need to generate a Client ID and Client Secret. If you already did this, find the location where you copied those values and be ready to copy and paste them into the Swagger UI.

There are two procedures on this page: the first is to generate your access token using the Client ID and Secret; the second is for generating a new access token using the refresh token.

To generate an access token via Swagger Docs UI

  1. Navigate to the Swagger Docs UI for your region (https://<echo360URL>/api-documentation)
  2. Click the oauth2access_token operation located at the top of the list.
    Notice that the only operation available is a POST operation; obtaining an access token is always a POST call.
  3. Click the POST operation to expand it and show the fields that need to be completed.
    access token API call expanded to show fields for steps as described

    NOTE: There are a number of different ways to generate an access token; the instructions below are the recommended steps, but you do it a different way if you want to.
  4. In the grant_type field,  enter client_credentials.
  5. In the client_id field, enter/paste the client ID value generated with your API credentials.
  6. In the client_secret field, enter/paste the client secret value generated with your API credentials.
  7. At the bottom of the POST operation panel, click the Try it out! button.

As long as the values you entered into the fields is valid, you will receive a response that includes an access token, the expiration time (in seconds) and a refresh token.

access token request response with values as described

You may want to select and copy the Response body data into a separate text file.

To USE the access token in the Swagger Docs UI, copy the access token from the response, and paste it into the access token field at the top of the page.

top section of Swagger docs UI showing access token in field as described

As long as the pasted token is valid, you can run any of the API calls on the page.  Once the token expires, you can repeat the above steps to generate a new one, or use the Refresh token to generate a new access token

To generate a new access token using the refresh token

  1. Navigate to the Swagger Docs UI for your region (https://<echo360URL>/api-documentation)
  2. Click the oauth2access_token operation located at the top of the list.
    Notice that the only operation available is a POST operation; obtaining an access token is always a POST call.
  3. Click the POST operation to expand it and show the fields that need to be completed.
    access token API call expanded to show fields for steps as described
  4. In the grant_type field,  enter refresh_token.
  5. In the client_id field, enter/paste the client ID value generated with your API credentials.
  6. In the refresh_token field, enter/paste the refresh token value you received with your original access token.
  7. At the bottom of the POST operation panel, click the Try it out! button.

As long as the values you entered into the fields is valid, you will receive a response that includes a new access token, the expiration time (in seconds) and a new refresh token.