Users

The User object represents an individual user in the Marketplace platform. This object contains the following properties:

Field	Type	Description
id	string	The primary identifier for the user. Example: USR-1671-0642
href	string	The relative reference to the object. Example: /v1/accounts/users/USR-1671-0642
email	string	The email address of the user. Example: [email protected]
status	string	The status of the user. Possible enum values: New Invited Invitation Expired Active Blocked Disabled Deleted A user can have Invited or InvitationExpired status only if they haven't joined the account.
name	string	The name of the user. Example: Will Smith
firstName	string	The first name of the user. Example: Will
lastName	string	The last name of the user. Example: Smith
phone	object	The country code and phone number of the user. Example: { "prefix": "+34", "number": "660707172" }
SSO	bool	A flag to indicate if the user logs in using SSO. Example: true
acceptedTerms	bool	A flag to indicate if the user has accepted the terms and conditions. Example: true
accounts	account	The list of accounts to which the user has been added. Example: [ { "id": "ACC-1671-0642", "name": "You Are a Test Account" } ]
groups	group	All groups that the user belongs to. Example: [ { "id": "UGR-5116-6265", "name": "Administrators" }, { "id": "UGR-5116-6565", "name": "Fulfillment Managers" } ]
invitation	object	The invitation object. This is added only in the context of the account (on account sub-collection), and only in case of the user being invited. Example: { "code": "910B14E6CB2343A09CB32F24BBC4BEF1", "status": "Invited" }
invitation.code	string	The invitation code sent to user to invite them to the platform. Example: 910B14E6CB2343A09CB32F24BBC4BEF1
invitation.status	string	The invitation status for the user in the account. Example: Invited
audit	audit	Represents the audit object. Example: { "created": { ... }, "updated": { ... }, "joined": { ... }, "login": { ... }, "access": { ... } }

Example

USER OBJECT

{
  "id": "USR-6375-2499",
  "email": "[email protected]",
  "name": "John Smith",
  "firstName": "John",
  "lastName": "Smith",
  "status": "Invited",
  "phone": { 
      "prefix": "+34",
      "number": "660707172"
  },
  "accounts": [
		{
			"id": "ACC-1671-0642",
			"icon": null,
			"name": "You Are a Test Account"
		}
  ],
  "group": [
      {
        "id": "UGR-5116-6265",
        "name": "Administrators"
      },
      {
        "id": "UGR-5116-6565",
        "name": "Fulfillment Managers"
      }
  ],
  "invitation": {
    "code": "910B14E6CB2343A09CB32F24BBC4BEF1",
    "status": "Invited"
  }
}