This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

Associate

Type: object

This object represents the associate user
Examples:

{
    "email": "jhon.doe@sonepar.com",
    "accountIds": [
        "123456",
        "123789"
    ],
    "status": "ACTIVE"
}

{
    "email": "jane.doe@sonepar.com",
    "accountIds": [
        "123456"
    ],
    "status": "ACTIVE"
}

{
    "email": "brice.soto@sonepar.com",
    "status": "ACTIVE",
    "allAccountsAccess": true
}

root email
Type: string

the email of the associate user, it represents his unique identifier
Example:

"jhon.doe@sonepar.com"

root accountIds
Type: array of string

List of unique identifiers of the accounts for which the associate can work on behalf of users attached to them

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root accountIds accountIds items
Type: string

Unique identifier of an account
Examples:

"123456"

"123789"

root status
Type: enum (of string) Default: "ACTIVE"

The current status of the associate user within an OpCo. If is set to DELETED spark will delete the associate.

Must be one of:

  • "ACTIVE"
  • "DELETED"

Example:

"ACTIVE"

root allAccountsAccess
Type: boolean

A boolean field,if it is true, it means that the associate has access to all accounts within the OpCo.
Example:

"true"

root orgIds
Type: array of string

List of unique identifiers of the commercial organisations for which the associate user has the right to access on behalf to all associated accounts. This field is taken into account only if 'allAccountsAccess' is true

 No Additional Items

Each item of this array must be:

root orgIds orgIds items
Type: string

Unique identifier of a commercial organisation within the OpCo
Examples:

"ORG-1"

"ORG-3"