User Object

Defines the schema for configuring a User Account

API Endpoint
Supported MethodsPOST, GET, PATCH, DELETE


The Users object schema includes the following attributes.

idUnique identifier for the SCIM Resource as defined by the Service ProviderString
userNameUnique identifier for the User, typically used by the user to directly authenticate to BigPandaString
displayNameThe name of the user as displayed in the BigPanda UIString
metaTags containing metadata about the user account.

created - The DateTime ( ISO 8601) the resource was added to the Service Provider

location - The URI of the resource being returned
activeIndicates if the user's administrative status is active and can authenticate to BigPanda.Boolean
passwordThe user's initial clear text password.
This attribute is used to specify an initial password when creating a new User.
This value will never be returned by a Service Provider in any form
phoneNumbersThe user’s phone number. BigPanda supports only 1 phone number per user

value - the string with the phone number

type - what type of number. Options are: work, home, other
rolesA list of BigPanda roles assigned to the userArray of Strings

Sample Object:

  "id": "5f82d3495558352a180e51cb",
  "userName": "[email protected]",
  "displayName": "Stella R",
  "active": true,
  "meta": {
    "created": "2020-10-11T09:41:29.372Z",
    "location": ""
  "schemas": [
  "roles": [
  "phoneNumbers": [
      "value": "5556345375",
      "type": "other"