SCIM Users

The BigPanda SCIM Users API enables users to provision and manage user accounts and roles.

🚧

Beta Feature

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.

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 permissions can use the SCIM Users API:

PermissionDescription
Users_ReadRetrieve the list of users in BigPanda
Users_Full_AccessRetrieve, add, edit, and delete users in BigPanda

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

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.

Available Objects & Actions

The SCIM Users API provides the following objects:

ObjectDescriptionSupported MethodsAPI Endpoint
UserDefines the schema for configuring a User AccountPOST, GET, PATCH, DELETEhttps://api.bigpanda.io/resources/v2.0/scim/Users
Service Provider Config ObjectDefines the schema for the Service Provider Configuration ObjectGEThttps://api.bigpanda.io/resources/v2.0/scim/ServiceProviderConfigs

Use the SCIM Users API to perform these actions:

ActionDefinitionDescription
Retrieve ConfigurationGET
/resources/v2.0/scim/ServiceProviderConfigs
Retrieves the service provider configuration details of BigPanda's SCIM API
Retrive User SchemaGET
/resources/v2.0/scim/Schemas/urn:scim:schemas:core:1.0:User
Retrieves the User Schema details for the SCIM API
Retrieve All SchemasGET
/resources/v2.0/scim/schemas
Retrieves all schemas associated with the SCIM API
Retrieve User by IDGET
/resources/v2.0/scim/Users/{id}
Retrieves a specific user schema
Retrieve UsersGET
/resources/v2.0/scim/Users
Retrieves a list of all users within the organization
Create UsersPOST
/resources/v2.0/scim/Users
Creates a new user
Update UserPATCH
/resources/v2.0/scim/Users{id}
Updates field values for a user
Delete UserDELETE
/resources/v2.0/scim/Users/{id}
Deactivates a user account in the system