Edge Technologies, Inc. | Documentation

EdgeCore version: 4.3.0

Method

GET/public/roles/{roleName}

Used to retrieve a particular role.

Parameters

Name	Type	Description	Mandatory
roleName	string	Role that you want to retrieve	Yes

cURL example

curl --location --request GET 'http://3.23.104.142:8080/public/roles/Editor' \
--header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5'

Example Response

{
    "doClass": "AccountRoleDO",
    "id": "l9o4v4-2hv1git3j6ko",
    "hidden": false,
    "name": "Editor",
    "userCount": -1,
    "adapterName": "embedded",
    "deletable": true,
    "attributes": {},
    "permissions": [],
    "securityPermissions": [
     {
            "doClass": "SecurityPermissionDO",
            "name": "permission.provisioning.content",
            "displayName": "Assign Content",
            "subPermissions": []
        },
        {
            "doClass": "SecurityPermissionDO",
            "name": "permission.pipeline",
            "displayName": "Edit Pipeline",
            "subPermissions": []
        },
        {
            "doClass": "SecurityPermissionDO",
            "name": "permission.content",
            "displayName": "Content (Pages & Folders)",
            "subPermissions": [
                {
                    "doClass": "SecurityPermissionDO",
                    "name": "permission.content.edit",
                    "displayName": "Edit",
                    "subPermissions": []
                },
                {
                    "doClass": "SecurityPermissionDO",
                    "name": "permission.content.view",
                    "displayName": "View",
                    "subPermissions": []
                }
            ]
        }
    ],
    "privileges": {},
    "notificationTemplateIds": [],
    "parentRoleId": null
}

Response Fields

Name	Type	Description
doClass	string	Name of the object’s class
id	string	Auto-generated id
hidden	boolean	LDAP related
name	string	The role name
userCount	integer	Number of users in the role
adapterName	string	“embedded” for internal roles; otherwise name of the LDAP adapter if the role comes from LDAP
deletable	boolean	Indicates whether the role can be deleted
attributes	object	LDAP related
permissions	array	List of domain permissions
securityPermissions	array	List of security permissions
privileges	object	RPA related
notificationTemplateIds	array	List of IDs for any pipeline notifications that have been activated for the role
parentRoleId	string	LDAP related

HTTP Response

Code	Status	Description
200	OK	The request has succeeded.