See api-docs Menu

Set Role Apps

Use this API to assign applications to a role.









Resource URL

https://<api-domain>/api/2/roles/:id/apps

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

Content-Type

required

string

Set to application/json.

Request Parameters

app_id

required

array

The complete list of app_id values to assign to the role. To add or remove additional apps, submit the complete list in your request. Don’t submit a partial list of app IDs, to add or remove, in your request.

For example: [123, 456, 678].

Sample Responses

The response returns an array of app IDs sent in the request.


[
    {
        "id": 1029591
    },
    {
        "id": 760112
    }
]

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

The requested app IDs don’t exist.

{
    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for Roles API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Set Role Apps

curl 'https://<api-domain>/api/2/roles/:id/apps' \
-X PUT \
-H "Authorization: bearer <access_token>"
-H "Content-Type: application/json" \
-d '[123, 456, 789]'

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.