REST API Reference

Back Next

Creating a role

You can create custom roles for your organization.

POST request

To create a custom role, send a POST request using the following URI:

/public/core/v3/roles

The number of users, user groups, and roles combined cannot exceed 1000 for an organization.

Include the following information:

Field	Type	Required	Description
name	String	Yes	Name of the role.
description	String	-	Description of the role.
privileges	Array	Yes	IDs of the privileges to assign to the role. A role must have at least one privilege assigned to it.

POST response

If successful, returns the roles object with the details you included in the POST request.

POST example

To create a custom role, you might send a request similar to the following example:

POST <baseApiUrl>/public/core/v3/roles
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "name" : "CAIviewer",
    "description": "A role to view Application Integration designer and assets",
    "privileges" : ["aQwUdcM8RcQewA1yWphZ4F", "0nTOXl8dzEwlSFoM0cO8gI"]
}

You might receive a response similar to the following example:

{
    "id": "8j2MPlr8ubZgteIOwleSCk",
    "orgId": "cPYWk02I4aBeuLEvYRtaMS",
    "createdBy": "a@abc.com",
    "updatedBy": "a@abc.com",
    "createTime": "2019-03-20T18:33:33.361Z",
    "updateTime": "2019-03-20T18:33:33.428Z",
    "roleName": "CAIviewer",
    "description": "A role to view Application Integration designer and assets",
    "displayName": "CAIviewer",
    "displayDescription": "A role to view Application Integration designer and assets",
    "systemRole": false,
    "status": "Enabled",
    "privileges": [
        {
            "id": "0nTOXl8dzEwlSFoM0cO8gI",
            "name": "view.ai.designer",
            "description": "View application integration designer"
        },
        {
            "id": "aQwUdcM8RcQewA1yWphZ4F",
            "name": "view.ai.assets",
            "description": "View  application integration assets"
        }
    ]
}

Roles

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage