GET Roles

entity management (em) contains role data that is associated to groups the user, group, role and permission records work in conjunction with each other to control workflow activities and what users can or cannot do within the system roles and users are associated to groups using group management, and permissions are associated to roles using role management for more information about the data driving this function, refer to the em application data document purpose the purpose of the get roles api is for the client to obtain a complete listing of all role data used within the system from the server role data values may be required to be included in certain other api requests components http method get server url {baseurl} endpoint /roles headers h 'content type application/json' h 'authorization bearer {token} ' body none curl code the curl code for the above api components would look like the below command where the tags are replaced with the respective values curl x get ' {baseurl} /roles h 'content type application/json' h 'authorization bearer {token} ' request the table below includes shading to help identify key areas base api parameters the base api parameters are shaded green and represent the call parameters request data and parameters the table below also indicates the required and optional (blank) data and parameters to be provided by the client always means the value is always required regardless of the action requested (add, remove, update) new means the value is required for a new object being created existing means the value is required for an existing object being removed or updated conditional means the field is required if the object is present or the specified condition is met / request sample get {{baseurl}}/roles/light?includeinactive=false\&includesystem=true\&includeplatformsystemroles=false field name description baseurl string required replace with the actual url of the system environment token string required replace with a valid access token includeinactive boolean default is 'false' returns only active roles or includes inactive roles based on this value includesystem boolean default is 'false' returns only non system roles or all types of roles based on this value system roles are managed by the system and are used in specific places within the application (e g , entity user role, entity partner role) includeplatformsystemroles boolean default is 'false' returns only non platform system roles or all roles based on this value platform roles are managed by the system this is not used at this time but may appear on some roles response the response is an array of data returned from the server to the client based on the example request(s) above the following response codes will be returned 200 = ok the request was successful 400 = bad request validation error caused by malformed request ensure the payload sent adheres to the requirements 401 = unauthorized authentication error caused by unauthorized token provide a valid authentication token 403 = forbidden forbidden resource caused by lack of necessary privilege verify end point url and resource info 404 = resource not found the resource is invalid or not available verify end point url and resource info 415 = unsupported media type server is refusing to service the request because the payload is in a format not supported by this method verify request payload 500 = internal server error the system encountered an unexpected problem try again or submit a support ticket 503 = service unavailable the service is unavailable due to temporary overload or scheduled maintenance try again or submit a support ticket response data the data structure of the array returned in the response is defined below field name description roleid roleid long the unique object identifier of the role rolename rolename string the name of the role roledesc roledesc string required required the description of the role isactive isactive boolean the flag that indicates whether the role is active (true, false) attributes attributes object a list of key\ value pairs associated to the group (e g , partner role, entity role) attributes attributes isentityrole isentityrole string indicates if the role is an entity user role if “t”, the role displays in the dropdown list in the user interface attributes attributes ispartnerrole ispartnerrole string indicates if the role is an entity partner role if “t”, the role displays in the dropdown list in the user interface attributes attributes is platform system role is platform system role string indicates if the role is a system role controlled by the platform transactionid transactionid string the system generated hash/alphanumeric identifier of the workflow instance issystemrole issystemrole boolean indicates if the role is a system controlled role objecttypecode objecttypecode long the unique object identifier that indicates the type of object the role can be associated to values are found in reference data as category object type visible visible boolean indicates if the role is visible within the user interface response sample \[ { "roleid" 10135, "rolename" "admin role", "roledesc" "the person holding this role is a system administrator ", "isactive" true, "transactionid" "aa62f4b3 6c3a 481c bf6c f1ffff670b4a", "issystemrole" false, "visible" true }, { "roleid" 106, "rolename" "audit", "roledesc" "audit", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 5", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 10134, "rolename" "basic jan user", "roledesc" "starting with minimum ", "isactive" true, "transactionid" "a4ed94f8 967a 4a79 ae9e f34c397960de", "issystemrole" false, "visible" true }, { "roleid" 122, "rolename" "basic user", "roledesc" "basic user", "isactive" true, "transactionid" "dfaf3ede 1bb9 4fee 9cfd 300a29cef6cf", "issystemrole" true, "objecttypecode" 70007, "visible" true }, { "roleid" 10037, "rolename" "collaborator", "roledesc" "collaborator", "isactive" true, "transactionid" "flyway 3 7 3", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 107, "rolename" "concurring", "roledesc" "concurring", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 4", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 108, "rolename" "consulting", "roledesc" "consulting", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 4", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 10043, "rolename" "dm collaborator", "roledesc" "test collaborator role with less permissions then current out of the box ", "isactive" true, "transactionid" "cef8ee0c 9228 4adb ae38 f7b71ca5ed9f", "issystemrole" false, "visible" true }, { "roleid" 10044, "rolename" "dm request manager", "roledesc" "testing the role with limited permission ", "isactive" true, "transactionid" "1ae6e7c8 c083 4562 9cf5 39de2bf19761", "issystemrole" false, "visible" true }, { "roleid" 10042, "rolename" "dm request searcher", "roledesc" "this is just a test role that can be granted to users so they can only search and view published requests ", "isactive" true, "transactionid" "6ff6b501 53d6 4043 9798 b27d34cb311a", "issystemrole" false, "visible" true }, { "roleid" 114, "rolename" "eligible to be responsible party", "roledesc" "eligible to be responsible party", "isactive" true, "transactionid" "de57e667 d84d 4285 a1f8 13877dc61218", "issystemrole" false, "visible" true }, { "roleid" 103, "rolename" "entity approval delegate", "roledesc" "entity approval delegate", "isactive" true, "attributes" { "isentityrole" "t" }, "transactionid" "user default transaction", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 121, "rolename" "entity monitor", "roledesc" "entity monitor", "isactive" true, "transactionid" "561ed7a2 077a 4d9e b470 e0c50c8c5de3", "issystemrole" false, "visible" true }, { "roleid" 109, "rolename" "fa", "roledesc" "fa", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 4", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 115, "rolename" "global level 1 entity reviewer", "roledesc" "global level 1 entity reviewer", "isactive" true, "transactionid" "user default transaction", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 116, "rolename" "global level 2 entity reviewer", "roledesc" "global level 2 entity reviewer", "isactive" true, "transactionid" "user default transaction", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 1, "rolename" "internal system administrator", "roledesc" "internal system administrator", "isactive" true, "transactionid" "user default transaction", "issystemrole" true, "objecttypecode" 70007, "visible" true }, { "roleid" 123, "rolename" "lap approver", "roledesc" "lap approver", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 5", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 120, "rolename" "lap informed party", "roledesc" "lap informed party", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 5", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 110, "rolename" "lcsp", "roledesc" "lead client service partner", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 4", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 117, "rolename" "member firm level 1 entity reviewer", "roledesc" "member firm level 1 entity reviewer", "isactive" true, "transactionid" "7c770b89 eabb 4811 85ca 58b6e6bbcc19", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 118, "rolename" "member firm level 2 entity reviewer", "roledesc" "member firm level 2 entity reviewer", "isactive" true, "transactionid" "2dcd5ac9 a54b 4dd1 9ed3 f1e7f76c6534", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 101, "rolename" "partner role", "roledesc" "partner role", "isactive" true, "transactionid" "9a61c4f3 c8cf 4212 bb88 9290c36c2a5e", "issystemrole" true, "objecttypecode" 70007, "visible" true }, { "roleid" 111, "rolename" "ra", "roledesc" "ra", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 4", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 5003, "rolename" "request collaborator", "roledesc" "request collaborator", "isactive" true, "transactionid" "dmp manualscript 1 3 0", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 5001, "rolename" "request manager", "roledesc" "request manager", "isactive" true, "transactionid" "dmp manualscript 1 3 0", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 5002, "rolename" "request reviewer", "roledesc" "request reviewer", "isactive" true, "transactionid" "dmp manualscript 1 3 0", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 102, "rolename" "responsible party", "roledesc" "responsible party", "isactive" true, "attributes" { "isentityrole" "t" }, "transactionid" "user default transaction", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 10035, "rolename" "scim role", "roledesc" "invoke synchronization api", "isactive" true, "transactionid" "flyway 3 4 11", "issystemrole" true, "objecttypecode" 70007, "visible" true }, { "roleid" 119, "rolename" "service request management", "roledesc" "service request management", "isactive" true, "transactionid" "flyway 1 4 1", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 104, "rolename" "services approval delegate", "roledesc" "services approval delegate", "isactive" true, "attributes" { "isentityrole" "t" }, "transactionid" "user default transaction", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 105, "rolename" "services assistance delegate", "roledesc" "services assistance delegate", "isactive" true, "attributes" { "isentityrole" "t" }, "transactionid" "user default transaction", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 1, "rolename" "supervisor", "roledesc" "supervisor", "isactive" true, "transactionid" "f1e1a3b7 6bf9 4d16 95fe 3a2839b49562", "issystemrole" true, "objecttypecode" 70005, "visible" true }, { "roleid" 5, "rolename" "system administrator", "roledesc" "system administrator", "isactive" true, "attributes" { "is platform system role" "false" }, "transactionid" "cecf5869 9b27 40a6 a231 90cedbe0efed", "issystemrole" false, "objecttypecode" 70007, "visible" true }, { "roleid" 112, "rolename" "tax and legal", "roledesc" "tax and legal", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 4", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 113, "rolename" "treasury", "roledesc" "treasury", "isactive" true, "attributes" { "isentityrole" "t", "ispartnerrole" "t" }, "transactionid" "flyway 1 4 4", "issystemrole" true, "objecttypecode" 70004, "visible" true }, { "roleid" 10000, "rolename" "unlock", "roledesc" "unlock", "isactive" true, "transactionid" "29fa9618 d661 46a9 a567 eeabe9e25cf3", "issystemrole" false, "objecttypecode" 70007, "visible" true } ] attachments image2022 4 14 8 33 20 png (image/png) image2022 4 14 8 31 58 png (image/png) document generated by confluence on oct 15, 2024 11 10 atlassian http //www atlassian com/