getRole

Click to copy

Get a single role in the workflow system

A role can be used to configure what member users can do within the workflow application. Privileges are associated to roles and then those roles are associated to groups in the organization. This association permits or restricts application functionality based on what groups a user is a members of.

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

roleName

string

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/{roleName} \
  -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
{
  "roleName": "string",
  "description": "string",
  "privileges": [
    "string"
  ]
}
StatusMeaningDescriptionSchema

200

OK

success

Role

404

Not Found

error

WorkflowExceptionDTO

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