Apply a Permission Templates
Lets you apply a permission template at the user, group and role level.
You have to pass the “TemplateId” and the list of “UserIds”, “GroupIds” and “RoleIds” in the JSON body.
API URL
URL
POST
https://{host}/v2/PermissionTemplate.svc/Apply?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"Id":"3d6565bc-dbfe-11e7-9f0f-0236dfe9c25a",
"UserIds":[
"c0375139-ed43-11ec-993a-06f221480cd8",
"7d3ee26a-ec9c-11ec-993a-06f221480cd8"
],
"GroupIds":[
"f4819df8-1621-11ec-993a-06f221480cd8",
"022bc5d4-0fba-11e8-871e-02bf1924461c"
],
"RoleIds":[
"Sales_User",
"Marketing_User"
]
}
Request Parameters
| Parameter | Description |
|---|---|
| Id | The Id of the permission template. You can find it using the Get Permission Template API. |
| UserIds | The Ids of the users you’re applying the permission template to. You can find it using the Get Users API. |
| GroupIds | The Ids of the groups you’re applying the permission template to. You can find it using the Get Sales Groups API. |
| RoleIds | The Ids of the roles you’re applying the permission template to. |
Response
200 OK
Content-Type: application/json
{
"Status":"Success",
"Message":{
"IsSuccessful":true
}
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
