Appearance
User Object Reference
This User object describes a registered user.
json
{
"UserName" : "sallydoe@company.com",
"Status" : "Active",
"Role" : "TrialUser",
"FirstName" : "Sally",
"LastName" : "Doe",
"Organization" : "Sally's Company",
"ApiExpirationDate" : "2023-01-31T00:00:00Z",
"DaysRemaining" : 30,
"Created": "2023-01-01T00:00:00Z",
"Timestamp": "2023-01-18T09:42:58Z"
}
Attributes
UserName - string
Lowercase rendering of the user's email address.
Status - string
Valid status codes are:
User status codes
Status | Description |
---|---|
Pending | Awaiting user email confirmation |
Active | User may execute Key is valid for use |
Inactive | A user whose organization has an account setup to use Zypr, but has not yet been granted priviledges by the organization's account administrator |
Activation code expired | The activation code email to user has expired |
Api key expired | API key is no longer valid |
Customer subscription expired | User's API key expiry corresponds to their organizations subscription term, which has expired |
Role - string
Role of user. Valid roles are:
Valid user roles
Role | Description |
---|---|
Anonymous | An unregistered user |
Trial User | A user whose organization does not have an account setup to use Zypr |
User | A user who has been setup by their organization's account administrator as a named user, which grants them permissions corresponding to their organization's account |
AccountAdmin | A user who is responsible for their organization's enterprise-wide account administration |