Reference Guide

SupportAssist Enterprise
23 REST API Guide – SupportAssist Enterprise
2.4 Credential Profile
A Credential Profile is a collection of Account Credentials of various device types. Credential Profiles enable you
to assign a set of credentials to your devices, instead of entering the credentials for each device manually.
The JSON schema for creating and updating Credential Profile is as follows:
{
"type" : "object",
"id" : "CredentialProfile",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"credentialAccounts" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "DeviceCredentialAccount",
"properties" : {
"id" : {
"type" : "string"
}
}
}
}
}
}
Parameters required for creating Credential Profiles
Parameter
Description
Additional details
id
Auto-generated identifier of a Credential
Profile entity.
name
Name that you want to assign to the
Credential Profile.
This attribute is required.
credentialAccounts
A collection of Credential Accounts.
id
Unique identifier assigned to the
Credential Account.
SupportAssist Enterprise requires
the id attribute to associate
Credential Accounts with Credential
Profiles.
Note: The id of each Credential Account is required for creating or updating a Credential Profile.
2.4.1 Create Credential Profile
The following resource URI is used to create a Credential Profile:
https://<BASE_URI>/SupportAssist/api/v1/CredentialProfile
Method: POST