No Results
Add Role
Article Contents

EdgeCore version: 4.3.0

Method

POST /public/roles/{roleName}

Used to create a new role in EdgeCore.

 

cURL example

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

 

Parameters

Name Type Description Mandatory 
roleName
 string Name of the role you want to add Yes

 

Example Response

{
    "doClass": "AccountRoleDO",
    "id": "l9o4v4-2hv1git3j6ko",
    "hidden": false,
    "name": "Editor",
    "userCount": -1,
    "adapterName": "embedded",
    "deletable": true,
    "attributes": {},
    "permissions": [],
    "securityPermissions": [],
    "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
201 Created The request has succeeded and a new resource has been created as a result.

 

Terms | Privacy
×