​
Description

The Permission Group object sets a specific level of permissions for Dashboard users. Each SSO is assigned a Permission Group that defines which API elements the user is allowed to view, edit, and create in the Dashboard.

By default, Mangopay provides 3 Permission Groups:

  • READ – Allows the Dashboard user to view operational data relating to users, payments, and compliance, but not platform settings.
  • WRITE – Allows the Dashboard user to view (like READ) and edit operational data relating to users, payments, and compliance, but not platform settings.
  • ADMIN – Allows the Dashboard user to view and edit operational data (like WRITE), as well as view and edit the platform settings (Client, SSO, and Permission Group objects).

​
Attributes

Id
string

The unique identifier of the object.

Name
string

The name of the permission group.

Tag
string

Max. length: 255 characters

Custom data that you can add to this object.

Type
string

Returned values: DEFAULT, CUSTOM

The type of permissions which can either be:

  • DEFAULT – One of the default groups provided by Mangopay (ADMIN, WRITE, READ). These permission groups cannot be modified.
  • CUSTOM – Editable permission groups created by the platform.
CreationDate
timestamp

The date and time at which the object was created.

Scopes
object

The detailed permissions for the permission group.

Was this page helpful?

View a ClientCreate a Permission Group