User Object

Defines the schema for configuring a User Account

API Endpointhttps://api.bigpanda.io/resources/v2.0/scim/Users
Supported MethodsPOST, GET, PATCH, DELETE

Parameters

The Users object schema includes the following attributes.

Attribute

Description

Type

Example

id

Unique identifier for the SCIM Resource as defined by the Service Provider

String

"id" : "2819c3861555646"

userName

Unique identifier for the User, typically used by the user to directly authenticate to BigPanda

String

"userName": "[email protected]"

displayName

The name of the user as displayed in the BigPanda UI

String

"displayName": "Becky Sterling"

meta

Tags containing metadata about the user account.

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

location - The URI of the resource being returned

Object

"meta": { "created": "2016-09-22T08:40:19.996Z", "location": "https://api.bigpanda.io/resources/v2.0/scim/Users/57e398f30b0555a7487bfb33"

active

Indicates if the user's administrative status is active and can authenticate to BigPanda.

Boolean

"active": true

password

The 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

String

"password":"t1meMa$heen"

phoneNumbers

The user’s phone number. BigPanda supports only 1 phone number per user

Attributes:
value - the string with the phone number

type - what type of number. Options are: work, home, other

Object

"phoneNumbers": [ { "value": "555-555-5555", "type": "other" } ]

roles

A list of BigPanda roles assigned to the user

Array of Strings

"roles": [ "admin", "user" ]