Users
The User object represents an individual user in the Marketplace platform. This object contains the following properties:
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
string
The email address of the user.
Example: will.smith@softwareone.com
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:
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
The list of accounts to which the user has been added.
Example:
groups
All groups that the user belongs to.
Example:
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:
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
Represents the audit object.
Example:
Example
Last updated
Was this helpful?