Reference Guide

SupportAssist Enterprise
10 REST API Guide – SupportAssist Enterprise
2 SupportAssist Enterprise-Specific Resource Model
The following sub-sections represent a subset of the use cases that SupportAssist Enterprise supports. REST API
support and the operation support will be incrementally refined based on consumer feedback over multiple
SupportAssist Enterprise releases.
Note: REST API resource URIs are case sensitive.
2.1 Enable REST in SupportAssist Enterprise
You can enable or disable REST API in SupportAssist Enterprise. To enable the REST API, open SupportAssist
Enterprise, point to Settings and click Preferences. On the Preferences page, in the API Interface section,
select Enable API Interfaces for SupportAssist Enterprise.
Note: You can enable REST API interfaces only if you have registered SupportAssist Enterprise.
2.2 User authentication
Before performing any operation in SupportAssist Enterprise through the REST interface, it is necessary to
authenticate your user account. After successful authentication, an authentication token and a refresh token are
generated.
Note: The authentication token must be provided with every resource URI for performing any operation.
2.2.1 Generating the authentication and refresh token
The following resource URI is used to generate the authentication token and refresh token:
https://<BASE_URI>/SupportAssist/api/v1/auth/tokens
Method: POST
Headers:
Content-Type: application/json
Request body:
{
"username": "<user_name>",
"password":"<password>"
}
Parameters required in the request body
Parameter
Description
username
User name of the user account in the Domain\Username format. You can
use a period to indicate the local domain. For example,
MyDomain\MyUsername or .\Administrator.
password
Password of the system/domain user account.