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" : "Company",
"ApiExpirationDate" : "1/1/2023",
"DaysRemaining" : 60
}
Attributes
UserName - string
Lowercase rendering of the user's email address.
Status - string
Valid status codes are:
User status codes
Code | Description |
---|---|
Pending | Awaiting user email confirmation |
Active | User API Key is valid for use |
ActivationCodeExpired | Email activation code expired before confirmation |
ApiKeyExpired | API Key no longer valid |
Role - string
Role of user. Valid roles are:
Valid user roles
Role | Description |
---|---|
Anonymous | An unregistered user |
TrialUser | Same privileges as User role, but for set trial period |
User | A user who may execute simulations |
Admin | A user with account-level administration privileges |
AccountsAdmin | A user with multiple account-level administration privileges |