updateRole

Click to copy

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.

Body parameter

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

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
5
# You can also use wget
curl -X POST /{orgId}/{itemId}/community/roles/{roleName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

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

200

OK

success

Success

400

Bad Request

invalid role

WorkflowJsonExceptionDTO

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