Using Access Tokens to Send API Requests

Updated

You can use access tokens in a Bearer Token header of any REST API request. For example, with an access token with scope set to /subclient, you can retrieve the properties associated with a subclient.

API Request to Retrieve Subclient Properties

Syntax

GET <webservice>/Subclient/{subclientId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authorization: Bearer {access token}

    

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

subclientId

The subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authorization

The bearer token or access token that you can create for yourself or for a user group. For more information, see Creating an Access Token.