Contents
3 REST API Guide – SupportAssist Enterprise
Contents
Revisions............................................................................................................................................................................. 2
Introduction ......................................................................................................................................................................... 5
1 Key Integration Concepts ............................................................................................................................................. 6
1.1 Client Integration Overview ................................................................................................................................ 6
1.2 Base URI ............................................................................................................................................................ 6
1.3 Security ............................................................................................................................................................... 6
1.4 Authentication Mechanisms ................................................................................................................................ 6
1.5 Resource Operations .......................................................................................................................................... 7
1.6 Connectivity Considerations ............................................................................................................................... 7
1.7 Request Headers ................................................................................................................................................ 7
1.8 Response Codes ................................................................................................................................................ 8
1.9 Response Headers ............................................................................................................................................. 9
2 SupportAssist Enterprise-Specific Resource Model ................................................................................................... 10
2.1 Enable REST in SupportAssist Enterprise ....................................................................................................... 10
2.2 User authentication ........................................................................................................................................... 10
2.2.1 Generating the authentication and refresh token ............................................................................................. 10
2.2.2 Refreshing the authentication token ................................................................................................................. 11
2.3 Account Credentials ......................................................................................................................................... 12
2.3.1 Create Account Credentials .............................................................................................................................. 15
2.3.2 Edit Account Credentials .................................................................................................................................. 18
2.3.4 Retrieve Specific Account Credentials ............................................................................................................. 21
2.3.5 Delete Account Credentials .............................................................................................................................. 21
2.4 Credential Profile .............................................................................................................................................. 23
2.4.1 Create Credential Profile .................................................................................................................................. 23
2.4.2 Edit Credential Profile ....................................................................................................................................... 24
2.4.3 Delete Credential Profile ................................................................................................................................... 25
2.4.4 Retrieve Credential Profile ................................................................................................................................ 26
2.5 Retrieve Job status ........................................................................................................................................... 27
2.6 Devices ............................................................................................................................................................. 28
2.6.1 Add device ........................................................................................................................................................ 30
2.6.2 Edit device details ............................................................................................................................................. 31
2.6.3 Delete devices .................................................................................................................................................. 32
2.6.4 Retrieve devices ............................................................................................................................................... 33