Get a list of permission groups

  • Updated on Aug 9, 2024
  • Published on Aug 8, 2024
  • 2 minute(s) reading time
Prev Next
Get
/v{version}/PermissionGroups
Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Default"1.17"
Responses
200

OK

Array of object
object

Permission group

Id
integer (int32)

Unique ID of the permission group

Name
string

Name of the permission group

Type
string

Type of the permission group

Valid values[ "Admin", "Standard", "Location" ]
ComposerEditLevel
string

Composer edit level of the permission group

Valid values[ "FullAdmin", "RestrictedAdmin", "FullUser", "RestrictedUser", "Everyone" ]
Permissions
object (V1.Models.CmsPermissions)

User permissions in the IXM Platform

Playlist
boolean

If true, the user has access to the content/playlist tab in the IXM Platform. Default: false.

PlaylistManagement
boolean

If true, the user can manage playlists in the IXM Platform. Default: false.

PlaylistRelease
boolean

If true, the user can release playlists in the IXM Platform. Default: false.

MediaManagement
boolean

If true, the user has access to the content/media management tab in the IXM Platform. Default: false.

Archive
boolean

If true, the user can archive various entities such as spots in the IXM Platform. Default: false.

DataSources
boolean

If true, the user has access to the data sources tab of the player in the IXM Platform. Default: false.

Location
boolean

If true, the user has access to the channels/locations tab in the IXM Platform. Default: false.

PlayerMessages
boolean

If true, the user has access to the player notifications tab in the IXM Platform. Default: false.

ScreenLayout
boolean

If true, the user has access to the screen layout tab in the IXM Platform. Default: false.

ScreenLayoutManagement
boolean

If true, the user can manage screen layouts in the IXM Platform. Default: false.

ProgramScheme
boolean

If true, the user has access to the program scheme tab in the IXM Platform. Default: false.

ProgramSchemeManagement
boolean

If true, the user can manage program schemes in the IXM Platform. Default: false.

Reports
boolean

If true, the user has access to the reports tab in the IXM Platform. Default: false.

Administration
boolean

If true, the user has access to the administration tab in the IXM Platform. Default: false.

DashboardMessages
boolean

If true, the user has access to the widgets in the dashboard tab in the IXM Platform. Default: false.

DashboardWidgets
boolean

If true, the user has access to the widget shown in the dashboard tab in the IXM Platform. Default: false.

Dooh
boolean

If true, the user has access to the DOOH tab in the IXM Platform. Default: false.

Created
string (date-time)

Creation date in UTC

Modified
string (date-time)

Modification date in UTC

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Forbidden

500

Unexpected error

Expand All
object
Id
string
Type
string
Message
string
Values
object
property*
object additionalProperties