Adyen · JSON Structure

Management Company User Structure

CompanyUser schema from Adyen API

Type: object Properties: 11 Required: 5
PaymentsFinancial ServicesFintech

CompanyUser is a JSON Structure definition published by Adyen, describing 11 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

_links accountGroups active apps associatedMerchantAccounts email id name roles timeZoneCode username

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/management-company-user-structure.json",
  "description": "CompanyUser schema from Adyen API",
  "type": "object",
  "properties": {
    "_links": {
      "description": "References to resources connected with this user.",
      "$ref": "#/components/schemas/Links"
    },
    "accountGroups": {
      "description": "The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "active": {
      "description": "Indicates whether this user is active.",
      "type": "boolean"
    },
    "apps": {
      "description": "Set of apps available to this user",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "associatedMerchantAccounts": {
      "description": "The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "email": {
      "description": "The email address of the user.",
      "type": "string"
    },
    "id": {
      "description": "The unique identifier of the user.",
      "type": "string"
    },
    "name": {
      "description": "The user's full name.",
      "$ref": "#/components/schemas/Name"
    },
    "roles": {
      "description": "The list of [roles](https://docs.adyen.com/account/user-roles) for this user.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "timeZoneCode": {
      "description": "The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**.",
      "type": "string"
    },
    "username": {
      "description": "The username for this user.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "id",
    "email",
    "timeZoneCode",
    "username",
    "roles"
  ],
  "name": "CompanyUser"
}