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

POST
https://{host}/v2/PermissionTemplate.svc/Apply?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
    "Id": e946a417-dbf5-11e7-9f0f-0236dfe9c25a,
    "UserIds": [
        "abc1d2ef-3g0h-45i6-j0kl-07m89o1pq2r3",
        "stu1v2wx-3y0z-45a1-b0cd-02e34f5gh6i7"
    ],
    "GroupIds": [
        "090529bc-862c-11e6-88b9-0677ec402fcf",
        "0ec2b1d5-3d0f-11e5-b982-22000aa68b6f"
    ],
    "RoleIds": [
        "Sales_User",
        "Marketing_User"
    ]
}

JSON Properties

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.

GroupIds

The Ids of the groups you’re applying the permission template to.

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 Code

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.