User Parameters
The Users object schema includes the following attributes.
Attribute | Description | Type |
|---|---|---|
id | Unique identifier for the SCIM Resource as defined by the Service Provider | String |
userName | Unique identifier for the User, typically used by the user to directly authenticate to BigPanda | String |
displayName | The name of the user as displayed in the BigPanda UI | String |
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 |
active | Indicates if the user's administrative status is active and can authenticate to BigPanda. | Boolean |
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 |
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 |
roles | A list of BigPanda roles assigned to the user | Array of Strings |
Sample SCIM User Object
{
"id": "5f82d3495558352a180e51cb",
"userName": "[email protected]",
"displayName": "Stella R",
"active": true,
"meta": {
"created": "2020-10-11T09:41:29.372Z",
"location": "https://api.bigpanda.io/resources/v2.0/scim/Users/5f82d3495558352a180e51cb"
},
"schemas": [
"urn:scim:schemas:core:1.0"
],
"roles": [
"admin",
"user"
],
"phoneNumbers": [
{
"value": "+555-634-5375",
"type": "other"
}
]
}