Skip to content

updateRole

POST
Use dark colors for code blocksCopy
1
/{orgId}/{itemId}/community/roles/{roleName}
Create or update a role

Create or update a role with new privileges and groups. The new input values will replace any existing values defined for the role. 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. The adminAdvanced privilege is required.

Query parameters

NameTypeRequired
tokenstring¦null

Body parameters

Supported content types: application/json

Type: Role

A role object defining the role

NameTypeRequired
roleNamestring¦null
descriptionstring¦null
privileges[string]

Path parameters

NameTypeRequired
roleNamestring
orgIdstring
itemIdstring

Response status

StatusMeaningDescriptionSchema
200OK

success

Success
400Bad Request

invalid role

WorkflowJsonExceptionDTO

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/community/roles/{roleName} \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data '{"roleName":"string","description":"string","privileges":["string"]}'

Response

Use dark colors for code blocksCopy
1
2
3
{
  "success": true
}

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