User

The User object represents a single user on the Marketplace platform.

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) Primary identifier for the user.
email	string	The email address of the user.
status	string	(Read-only) The user's status. Allowed values: New Invited Invitation expired Active Blocked Disabled Deleted. The Invited or InvitationExpired statuses apply only if the user has not yet joined the account.
name	string, core	The user's full name.
firstName	string	The user's first name.
lastName	string	The user's last name.
phone	object	The country code and phone number.
accounts	object	List of accounts that the user is added to; not returned in the user’s account sub‑collection.
currentAccount	object	The account currently selected by the user.
groups	object	(Read-only) Represents the group object containing all groups that the user belongs to. Example: [ { "id": "UGR-5116-6265", "name": "Administrators" }, { "id": "UGR-5116-6565", "name": "Fulfillment Managers" } ]
buyers	object	(Read-only) List of all buyers the user can access through their groups. Not defined when the ‘All’ option is selected.
modules	object	(Read-only) List of all modules the user can access through their groups.
settings	object	(Optional) Indicates the user’s preferences, including language and regional settings (legacy).
invitation	object	(Optional) Represents the invitation object. This is included only in the context of an account (within the account sub‑collection) and only when the user has been invited.
invitation.code	string	(Read-only) (Optional) The invitation code sent to user when they are invited to the platform.
invitation.status	string	(Read-only) (Optional) Indicates the user's account invitation status.
audit	object	(Read-only) Represents the audit object.

Examples

ACCOUNT CONTEXT

USER OBJECT

{
    "id": "USR-3773-5838",    
    "email": "[e-mail]",
    "status": "Active",
    "firstName": "d",
    "lastName": "d",
    "settings": {
        "cultureCode": "en-US",
        "languageCode": "en-US"
    },
    "name": "d d",
    "account": {
        "id": "ACC-0774-6909",    
        "type": "Client",
        "status": "Active",
        "name": "Ignite Test CDG"
    },    
    "groups": [
        {
            "id": "UGR-5240-4954",          
            "name": "Only Marketplace and Buyer BUY-1089-7077",
            "description": "",
            "account": {
                "id": "ACC-0774-6909",               
                "type": "Client",
                "status": "Active",
                "name": "Ignite Test CDG"
            },
            "logo": "",
            "isDefault": false
        }
    ],
    "buyers": [
        {
            "id": "BUY-1089-7077",           
            "status": "Enabled",
            "address": {
                "addressLine1": "adress1",
                "addressLine2": "adress2",
                "postCode": "88131",
                "city": "city",
                "state": "bavaria",
                "country": "DE"
            },
            "account": {
                "id": "ACC-0774-6909",               
                "type": "Client",
                "status": "Active",
                "name": "Ignite Test CDG"
            },
            "name": "testBuyer"
        }
    ],
    "modules": [
        {
            "id": "MOD-0478",          
            "description": "Buy and manage subscription based licenses.",
            "isConfigurable": true,
            "isEnabledByDefault": true,
            "paid": false,
            "name": "Marketplace",
            "filters": {
                "group.buyers": [
                    "selected",
                    "all"
                ]
            },
            "settings": {
                "sharedAccount": true,
                "configurable": true,
                "default": true,
                "paid": false
            }
        }
    ],
    "invitation": {
        "url": "https://portal.s1.show/accept-invite?code=eyJjb2RlIjoiUzM0dVpsVWNjL0JSRTdpVXFSdFBpN2J4Z3BaY3VXNTFoM2d4WlN6T0xwdz0iLCJhY2NvdW50VXNlcklkIjoiQVVTUi0xMDQwLTg2MzYtNzI2NyJ9",
        "status": "Active"
    },
    "audit": {
        "login": {
            "at": "2024-05-09T14:40:28.886Z"
        },    
        "access": {
            "at": "2024-09-20T14:01:45.603Z"
        },
        "joined": {
            "at": "2024-05-09T14:40:28.886Z"
        },
        "created": {
            "at": "2024-05-09T14:40:28.958Z",
            "by": {
                "id": "TKN-7670-9957",
                "href": "/accounts/api-tokens/TKN-7670-9957",
                "name": "[DO NOT REMOVE] PyraProxy"
            }
        },
        "updated": {
            "at": "2024-09-16T12:33:03.761Z",
            "by": {
                "href": "//"
            }
        }
    }
}

GLOBAL CONTEXT