User API Object

Schema for creating, retrieving, updating, and deleting users via the Moogsoft API.

Note – Most user fields are read-only and reserved for internal use.

        {
           "blocked":false,
           "createdAt":"2021-01-14T19:41:53.787Z",
           "email":"[email protected]",
           "emailVerified":true,
           "excludeUserDeletion":true,
           "familyName":"Smith",
           "givenName":"Jane",
           "id":"6006f9d53201051581a69d76",
           "jwtPermissions":null,
           "lastLogin":1611866349732,
           "loginCount":4,
           "name":"Jane Smith",
           "numericId":30,
           "permissions":[
              "user:edit",
              "integrations:edit",
              "correlation:edit",
              "workflows:edit",
              "alerts:edit",
              "credentials:edit",
              "incidents:edit"
           ],
           "picture":"https://avators4us.com/avatar/jane-smith-023179.png",
           "role":"administrator",
           "status":"ACTIVE",
           "tenantName":"my-org",
           <!-- "tenants":null, -->
           "writtenAt":1611069909802
        }

email

string

User email.

id

string

Auto-generated user ID.

lastLogin

UTC timestamp

loginCount

integer

Total number of user logins.

name

string

numericId

integer

Deprecated. Use id instead.

permissions

list

The permissions for a user are determined by the user's role. See Managing Moogsoft Users.

role

enumerated string

Moogsoft supports three roles: owner, administrator, and operator. See Managing Moogsoft Users.

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.

writtenAt

string

Timestamp when the user was created or last updated.