Users

User Object

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

Field	Type	Description
id	string	Primary user identifier. Example: "USR-1671-0642"
href	string	Relative reference to object on API (always /v1/accounts/users/{id}). Example: "/v1/accounts/users/USR-1671-0642"
email	string	Email address of the user. Example: "[e-mail]"
status	string	Status of the user. enum values New Invited Invitation Expired Active Blocked Disabled Deleted A user can have the Invited or InvitationExpired status only if they haven't joined the account.
name	string	User's name. Example: "Will Smith"
firstName	string	First name of the user. Example: "Will"
lastName	string	Last name of the user. Example: "Smith"
phone	object	User's country code and phone number. Example: { "prefix": "+34", "number": "660707172" }
SSO	bool	Flag if a user logs using SSO. Example: "true"
acceptedTerms	bool	Flag if user has accepted terms and conditions. Example: "true"
accounts	Account	List of accounts that user is added to, not returned on users account sub-collection. Example: [ { "id": "ACC-1671-0642", "name": "You Are a Test Account" } ]
groups	Group	Groups that the user belongs to. Example: [ { "id": "UGR-5116-6265", "name": "Administrators" }, { "id": "UGR-5116-6565", "name": "Fulfillment Managers" } ]
settings
invitation	object	Added only in context of account (on account sub-collection), and only in case of user being invited. Example: { "code": "910B14E6CB2343A09CB32F24BBC4BEF1", "status": "Invited" }
invitation.code	string	Invitation code sent to user to invite them to the platform. Example: "910B14E6CB2343A09CB32F24BBC4BEF1"
invitation.status	string	Invitation status for the user in account. Example: "Invited"
audit	object	Meaning of audit events: On GLobal User created - when user was created (once in lifecycle). updated - when user parameters changed last time. login - when user last time logged in. blocked - when user was blocked last time. On account subcollection, in additional to above: invited - when user was invited into account (dropped on join). joined - when user was accepted invitation to account. access - when user last time switched to the account context. Example: { "created": { ... }, "updated": { ... }, "joined": { ... }, "login": { ... }, "access": { ... } }

Example

USER OBJECT

{
  "id": "USR-6375-2499",
  "href": "/v1/accounts/users/USR-6375-2499",
  "email": "[e-mail]",
  "name": "John Smith",
  "firstName": "John",
  "lastName": "Smith",
  "status": "Invited",
  "phone": { 
      "prefix": "+34",
      "number": "660707172"
  },
  "accounts": [
		{
			"id": "ACC-1671-0642",
			"href": "/accounts/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"
  }
}