Skip to main content
POST
Create a new role. Any relationships, in particular permissions, will be hydrated.

Authorizations

Authorization
string
header
required

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

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

201 - application/json

Created

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>