Roles

Configures a role resource.

$idstring Required

The unique identifier for the role resource.

$schemaconst Required

Specific value: "https://schema.yext.com/config/platform/role/v1"

namestring Required

The display name of the role.

descriptionstring Required

A brief description of the role. This description will show up in the UI when assigning roles to users.

permissionIdsarray of number Required

The ids of the permissions that a user is granted when assigned the role. A full list of permission ids can be found under Account Settings > Role Management by clicking on the Export Permission IDs (For Developers) button.

Each item of this array must be:

Type: number

The id of an individual permission that belongs to the role.

availableToSubAccountsboolean

True if the role should be available to sub-accounts, false otherwise.