Skip to main content
PATCH
Update a role by id. All permissions and entitlements included in the request body will update their counterparts in the database

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

role
string
required

Body

application/json
id
string
required
name
string
required
defaultRoleForNewUsers
boolean
required
autoprovisioned
boolean
required
externalId
string
required
moduleEntitlementsToAdd
object[]
required
moduleEntitlementsToRemove
object[]
required
permissionSetsToAdd
object[]
required
permissionSetsToRemove
object[]
required
usersToAdd
object[]
required

Entity for storing all information pertaining to a user.

usersToRemove
object[]
required

Entity for storing all information pertaining to a user.

usersToReplace
object[]
required

Entity for storing all information pertaining to a user.

userGroup
object
required

Response

200 - application/json

OK

id
string
required
active
boolean
required
created
string<date-time>
required
updated
string<date-time>
required
name
string
required
locked
boolean
required
superAdmin
boolean
required
defaultRoleForNewUsers
boolean
required
autoprovisioned
boolean
required
externalId
string
required
stepPermissionSets
object[]
required
moduleEntitlements
object[]
required
userGroup
object
required
users
object[]
required

Entity for storing all information pertaining to a user.

userCount
integer<int32>
required
moduleCount
integer<int32>