POST v1/bunits/{bunitId}/roles

Create a role.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId The ID of the business unit of the role integer

Required

Body Parameters

The role to create

Role
NameDescriptionTypeAdditional information
Inheritable This role is available to and reusable by users on business units descendant to the business unit that created it.
boolean

None.

Name Role name.
string

Required.

Description Role description.
string

None.

Privileges Privileges granted to this role.
Collection of Privilege

None.

BusinessUnit The business unit that created the role.
SimpleBusinessUnit

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

Response Information

Resource Description

The role with the created information

Role
NameDescriptionTypeAdditional information
Inheritable This role is available to and reusable by users on business units descendant to the business unit that created it.
boolean

None.

Name Role name.
string

Required.

Description Role description.
string

None.

Privileges Privileges granted to this role.
Collection of Privilege

None.

BusinessUnit The business unit that created the role.
SimpleBusinessUnit

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.