Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
AuthorisationGroup

AuthorisationGroup:Update

Update your custom authorisation group

patch/v2/authorisationgroups/{groupCode}

Path parameters

groupCodestring required

The AG-code for an authorisation group

Request body

namestring required

Name of the authorisation group.

descriptionstring required

Description of the authorisation group.

type'package' | 'right' | 'module' | 'null' nullable

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

requiredAuthorisationGroupstring nullable

AG-code of the authorisation group that is required before this authorisation group can be enabled.

linkedProfileCodestring nullable

CP-code of the linked company profile.

authorisationRightsstring[] required

Rights for the authorisation group.

translationsobject

Object containing translations for the authorisation group fields.

Example request

{
  "name": "Webshop developer",
  "description": "Authorisation group for Webshop developers",
  "requiredAuthorisationGroup": "AG-1234-4321",
  "linkedProfileCode": "CP-1234-4312",
  "authorisationRights": [
    "AR-0000-0001",
    "AR-0000-0002"
  ],
  "translations": {
    "name": {
      "nl_NL": "Webshop ontwikkelaar",
      "en_GB": "Webshop developer"
    },
    "description": {
      "nl_NL": "Autorisatiegroep voor Webshop ontwikkelaars",
      "en_GB": "Authorisation group for Webshop developers"
    }
  }
}

Response

AuthorisationGroup resource updated

codestring

The code of the authorisation group.

namestring

Name of the authorisation group.

descriptionstring

Description of the authorisation group.

type'package' | 'right' | 'module'

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

requiredAuthorisationGroupstring nullable

AG-code of the authorisation group that is required before this authorisation group can be enabled.

linkedProfileCodestring nullable

CP-code of the linked company profile.

publicboolean

Indicate if the authorisation group is public.

translationsobject

Object containing translations for the authorisation group fields.

createdAtstring date-time nullable

The date and time at which this entity was created in ISO-8601 (ATOM) notation

createdBystring nullable

The reference to an account or token whom created the entity

modifiedAtstring date-time nullable

The date and time at which this entity was modified in ISO-8601 (ATOM) notation.

modifiedBystring nullable

The reference to an account or token whom modified this entity

deletedAtstring date-time nullable

The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.

deletedBystring nullable

The reference to an account or token whom deleted the entity

Example response

{
  "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"
}