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

Get a role

Request Information

URI Parameters

Name	Description	Type	Additional information
bunitId	The ID of the business unit the role is related to	integer	Required
roleId	The ID of the role	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

The requested role

Role

Name	Description	Type	Additional 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