SCIM Endpoints

The System for Cross-domain Identity Management (SCIM) specification is designed to make managing user identities in cloud-based applications and services easier by providing a defined schema for representing users and groups. Use the Braze SCIM endpoints to manage automated user provisioning.

• 

  POST: Create Dashboard User Account
• 

  GET: Look Up Existing Dashboard User Account by Resource ID
• 

  GET: Search Existing Dashboard User Account by Email
• 

  PUT: Update Dashboard User Account
• 

  DELETE: Remove Dashboard User Account

important

These SCIM API endpoints require the custom SCIM integration. If you set up an identity provider (IdP) integration (Okta or Entra ID), you can’t use these endpoints; only one SCIM bridge can be set up per company. The IdP integrations create and delete user accounts automatically, and support SCIM group role mapping (early access) to manage access control by mapping IdP groups to custom roles.

How to export a list of users with dashboard access

Use this workflow to audit users who have access to your Braze dashboard.

1. Download the Security Event report from Settings > Admin Settings > Security Settings > Security Event Download.
2. Extract the user emails from the report.
3. For each email, use GET: Search Existing Dashboard User Account by Email to retrieve the user details.
4. If needed, use the returned resource id with GET: Look Up an Existing Dashboard User Account by Resource ID for additional user details.

For the full SCIM endpoint list, see SCIM Endpoints. For more information about the report source, see Downloading a security event report.