v1

latestOpenAPI 3.1.02026-07-242325051.4 MB

AuthorisationGroup

AuthorisationGroup:Browse

Get all AuthorisationGroups that are applicable and configured. You can use the AuthorisationGroup code (the AG-code) to give an account specific rights in e.g. the Merchants:Create API. If you have the appropriate rights you can also create your own custom authorisation groups

get/v2/authorisationgroups

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

instring

Get results that match any of the given purposes (comma-separated)

Filter on the purpose of the authorisationgroup (e.g. all groups that can be used for an authenticationToken).

{
  "eq": "account",
  "neq": "token",
  "in": "connection, token"
}

eqstring

Filter authorisation groups by type.

Type of authorisation group. Valid values are right, module, and package. Defaults to right when omitted.

Response

The Authorisation Groups.

countinteger

The amount of items the collection contains

pagesinteger

The amount of pages available

totalinteger nullable

The total items the collection contains

Example response

{
  "authorisationGroups": [
    {
      "code": "AG-1234-4321",
      "name": "Webshop developer",
      "description": "Authorisation group for Webshop developers",
      "requiredAuthorisationGroup": "AG-1234-4321",
      "linkedProfileCode": "CP-1234-4312",
      "purpose": {
        "account": true,
        "merchant": true
      },
      "public": true,
      "translations": {
        "name": {
          "nl_NL": "Webshop ontwikkelaar",
          "en_GB": "Webshop developer"
        },
        "description": {
          "nl_NL": "Autorisatiegroep voor Webshop ontwikkelaars",
          "en_GB": "Authorisation group for Webshop developers"
        }
      },
      "authorisationObjects": [
        {
          "code": "AO-0000-0001",
          "name": "api"
        },
        {
          "code": "AO-0000-0002",
          "name": "Account management"
        }
      ],
      "createdAt": "2024-06-04T08:15:00+01:00",
      "createdBy": "A-1234-4321",
      "modifiedAt": "2024-06-04T08:15:00+01:00",
      "modifiedBy": "A-1234-4321",
      "deletedAt": "A-1234-4321",
      "deletedBy": "A-1234-4321"
    }
  ],
  "count": 5,
  "pages": 2,
  "total": 10
}