This feature is available through the Beta program only and is not released for general availability. If you would like to request access to the Beta program, please contact [email protected]
The SCIM Users API is a tool to help you manage users in the BigPanda system, enabling you to bulk manage even large and complex userbases. SCIM specifications allow you to leverage an existing Lightweight Directory Access Protocol (LDAP), external directories, or SSO integrations.
The SCIM Users API is based on the open standard System for Cross-domain Identity Management (SCIM): Protocol 1.1. SCIM is an open standard used for automating the exchange of user identity information between identity domains or IT systems. Its purpose is to facilitate and ease the management of user identities in cloud based applications. BigPanda uses JSON-based formats for SCIM.
Roles with the following permissions can use the SCIM Users API:
|Retrieve the list of users in BigPanda|
|Retrieve, add, edit, and delete users in BigPanda|
To learn more about how BigPanda's permissions work, see the RBAC - Role Based Access Control guide.
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token.
To maintain quality of service, the Incidents API is limited to 2 requests per route, per second.
Additional requests will return a 429 response code and the request will need to be retried.
If you were using ur previous V1 Users API, it is easy to migrate to the improved SCIM Users API with a few simple steps. Read about migration best practices and functionality differences in the SCIM Users API Release Notes.
The SCIM Users API provides the following objects:
|Object||Description||Supported Methods||API Endpoint|
|User||Defines the schema for configuring a User Account||POST, GET, PATCH, DELETE||https://api.bigpanda.io/resources/v2.0/scim/Users|
|Service Provider Config Object||Defines the schema for the Service Provider Configuration Object||GET||https://api.bigpanda.io/resources/v2.0/scim/ServiceProviderConfigs|
Use the SCIM Users API to perform these actions:
Retrieves the service provider configuration details of BigPanda's SCIM API
Retrieves the User Schema details for the SCIM API
Retrieves all schemas associated with the SCIM API
Retrieves a specific user schema
Retrieves a list of all users within the organization
Creates a new user
Updates field values for a user
Deactivates a user account in the system