Browse the help center

Read one role and what it may do

The role and its permissions, as the console's role editor shows them.

Reference
GET https://YOUR-NETWORK-DOMAIN/rest-api/roles/{roleId}.do

The role and its permissions, as the console's role editor shows them. By default only the permissions the role actually holds, which is the answer to 'what can this role do'; 'includeNotGranted=true' adds the rows it does not hold, which is how a caller finds the name of a permission it wants to grant. Narrow a wide answer with 'group' (a group of the matrix), 'identity' (one row, exactly as the answer spells it) or 'contains' (a word of the row's name or title). Each row carries 'identity' -- the token this role's own permissions use -- the granting types each permission is currently set to, and the ones it could be set to. 'groups' lists the whole matrix's groups with their permission columns, whatever the filter. A role built on ADMIN also carries 'adminPages', the admin console pages it opens. Requires the Admin Roles & Permissions or User Roles & Permissions console permission; an ADMIN-built role needs the admin one.

Path Params

roleId integer required

1

Query Params

group string

One group of the matrix, as 'groups' names it

CAMPAIGNS_MANAGEMENT

identity string

One row, exactly as the answer spells it; a row over another role carries its id after #

CAMPAIGNS

contains string

Only rows whose name or title contains this

targeting

includeNotGranted boolean

Also the rows this role does not hold, which is the whole catalogue of what it could hold

false

Responses

200

{success, id, name, staticRole, identity, manageable, adminPages, groups, permissions, returned, more}

400

'group' or 'identity' names nothing in this role's matrix

401

Authentication error

403

The caller may not see this role

404

No role with that id

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.