getRoles

Click to copy

Get all the roles in the workflow system

Get all the roles in the workflow system, including role name, description and privileges associated with each role.

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
# You can also use wget
curl -X GET /{orgId}/{itemId}/community/roles \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "roles": [
    {
      "roleName": "string",
      "description": "string",
      "privileges": [
        "string"
      ]
    }
  ]
}
StatusMeaningDescriptionSchema

200

OK

success

Inline

404

Not Found

error

WorkflowExceptionDTO

Response details

Status Code 200

Roles

NameTypeRequired

roles

roleName

string¦null

description

string¦null

privileges

[string]

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.