The BigPanda SCIM Users API enables users to provision and manage user accounts and roles.
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.
SCIM
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.
Relevant Permissions
Roles with the following permission can use the SCIM Users API:
| Permission | Description |
|---|---|
| User Management | View, add, edit and delete Users in BigPanda Settings and the SCIM Users API. |
Permission access levels can be adjusted by selecting either View or Full Access. To learn more about how BigPanda's permissions work, see the Roles Management guide.
Authentication Necessary
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token.
Rate Limitations
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.
Migrating from the previous User API
SCIM V1 API End of Life
V1 of the SCIM Users API will be retired on February 19, 2024. The API will no longer be supported beginning November 19, 2023.
We encourage organizations to move their user management to the V2 SCIM Users API. The improved version of the API provides improved authentication, performance, and user experience.
If you are using the 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.
Available Objects & Actions
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:
| Action | Definition | Description |
|---|---|---|
| Retrieve Configuration | GET /resources/v2.0/scim/ServiceProviderConfigs | Retrieves the service provider configuration details of BigPanda's SCIM API |
| Retrive User Schema | GET /resources/v2.0/scim/Schemas/urn:scim:schemas:core:1.0:User | Retrieves the User Schema details for the SCIM API |
| Retrieve All Schemas | GET /resources/v2.0/scim/schemas | Retrieves all schemas associated with the SCIM API |
| Retrieve User by ID | GET /resources/v2.0/scim/Users/{id} | Retrieves a specific user schema |
| Retrieve Users | GET /resources/v2.0/scim/Users | Retrieves a list of all users within the organization |
| Create Users | POST /resources/v2.0/scim/Users | Creates a new user |
| Update User | PATCH /resources/v2.0/scim/Users{id} | Updates field values for a user |
| Delete User | DELETE /resources/v2.0/scim/Users/{id} | Deactivates a user account in the system |