GET v1/bunits/{bunitId}/roles?filterForUserId={filterForUserId}

Get all roles of a business unit.

Request Information

URI Parameters

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

Required

filterForUserId Filter privileges by another user's privileges. This option can be used when the active profile wants to see which roles are available to a user with less privileges. integer

None.

Body Parameters

None.

Response Information

Resource Description

A list of all roles of the business unit

Collection of 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.