Create Role

post

https://api.medocity.net/v3/role

Used to Create Role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

label

string

required

The name of the role, between 3 and 100 characters.

client

object

required

The ID of the client associated with this role.

description

string

A brief description of the role, between 5 and 250 characters.

status

string

The status of the role. Possible values: Active, Pending, Deleted, ToBeDeleted.

roleMetaType

string

required

The metadata type of the role. Possible values: Manager, Managed.

contentGroup

array of strings

A list of content group id's associated with this role.

contentGroup

applications

array of strings

A list of applications accessible through this role.

applications

dashboard

array of strings

required

A list of dashboards associated with this role.

dashboard*

healthSummaryDashboard

string

The ID of the health summary dashboard for this role.

tableauGroupId

string

The Tableau group ID associated with this role.

tableauAllAccess

boolean

Defaults to false

Specifies whether Tableau all-access is granted for this role.

tableauGroupAccess

boolean

Defaults to false

Specifies whether Tableau group access is granted for this role.

scopeForSelf

array of strings

A list of scopes for the role, specifying permissions for self-management.

scopeForSelf

scopeForOthers

array of strings

A list of scopes for the role, specifying permissions for managing others.

scopeForOthers

Response

200

Role created successfully