Schema for creating, retrieving, updating, and deleting users via the Moogsoft API.
Note – Most user fields are read-only and reserved for internal use.
{ "email": "[email protected]", "familyName": "Botsworth", "givenName": "Marilu", "role": "administrator", "roleId": "613662871cb0a310c2a9cb12", "tenantName": "abc_testing", "excludeUserDeletion": false, "isSSO": false, "id": "61f2fcb95430e778c42fae79", "numericId": 49, "emailVerified": true, "name": "Marilu Botsworth", "picture": "https://s.gravatar.com/avatar/cc27a6224d574588101cbf51caf3488a?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fja.png", "createdAt": "2022-01-27T20:12:40.322Z", "writtenAt": 1643314361233, "lastLogin": 1653328816751, "status": "ACTIVE", "blocked": false, "permissions": [ "user:edit", "correlation:edit", "integrations:edit", "workflows:edit", "credentials:edit", "alerts:edit", "incidents:edit", "catalog:edit", "incident-config:edit", "automation:edit" ], "jwtPermissions": null, "tenants": null, "source": "Invitation" }
- blocked
- createdAt
- emailVerified
- excludeUserDeletion
- familyName
- givenName
- id
- isSSO
- jwtPermissions
- lastLogin
- name
- numericId
- permissions
- picture
- role
- roleId
- source
- status
- tenantName
- tenants
- writtenAt
blocked
boolean
Reserved for internal use.
createdAt
string
Calendar time when the user was created.
email
string
User email.
emailVerified
boolean
Reserved for internal use.
excludeUserDeletion
boolean
Reserved for internal use.
familyName
string
The user's surname.
givenName
string
The user's first name.
id
string
Auto-generated user ID.
isSSO
boolean
Whether or not SSO is enabled for this user.
jwtPermissions
string
TBD Reserved for future use
lastLogin
UTC timestamp
name
string
numericId
integer
Deprecated. Use id
instead.
permissions
list
The permissions for a user are determined by the user's role. See Manage Moogsoft Users.
picture
string
URL to the image to display for the user in the Moogsoft UI. This is derived from the user's login information.
role
enumerated string
Moogsoft supports three roles: owner, administrator, and operator. See Manage Moogsoft Users.
roleId
enumerated string
TBD
source
string
The method used to add the user.
status
enumerated string
The user status can be "ACTIVE", "DELETED", or "INVITED" (the user was created and the system is waiting for a response to the invitation email).
tenantName
string
The name of the Moogsoft instance to which the user belongs.
tenants
list
This is used internally to track other namespaces associated with the user.
writtenAt
UTC timestamp
Timestamp when the user was created or last updated.