Docschargebeedocs

HomeBillingPaymentsRevRecGrowthReveal
Support

Product Updates


  • Release Notes

Getting Started


  • Overview
  • Chargebee Billing Data Centers
  • Object Relationship Model
  • Understanding Sites
  • Developer Resources
  • Chargebee Tech Glossary
  • Articles and FAQ

Implementing Chargebee


  • Implementation Guide
  • Go-live Checklist
  • Articles and FAQ

AI in Chargebee


  • Chargebee Agents
  • Chargebee Copilot
  • Chargebee MCP Server (Model context protocol)

Product Catalog


  • Product Catalog Overview
  • Coupons
  • Articles and FAQ

Subscriptions


  • Working with Subscriptions
  • Billing
  • Orders
  • Articles and FAQ

Customers


  • Managing Customers
  • Account Hierarchy
  • Email Notifications
  • Branding
  • Configure Multiple Languages
  • Articles and FAQ

Invoices, Credit Notes and Quotes


  • Invoices
  • Credit Notes
  • Quotes [Legacy]
  • Transactions
  • Articles and FAQ

Taxes


  • Overview
  • Configuring Taxes
  • Country-specific Taxes
  • Articles and FAQ

Hosted Capabilities


  • Overview
  • Hosted Checkout
  • Hosted Self-Serve Portal
  • Hosted Pages Features
  • Additional Hosted Pages
  • Payment Components
  • Managing payments with ChargebeeJS
  • Mobile-Optimized Hosted Pages
  • Articles and FAQ

Site Configuration


  • Users & Roles
  • Custom Fields & Metadata
  • Mandatory Fields
  • File Attachments & Comments
  • Advanced Filter Options
  • Multicurrency Pricing
  • Multi-decimal Support
  • Configuring Reason Codes
  • Events and Webhooks
  • API Keys
  • Time Zone
  • Time Machine
  • Transfer Configurations
  • Articles and FAQ

Reports and Analytics


  • RevenueStory
  • Home Dashboard
  • Frequently Asked Questions
  • FAQs for Classic Reports Sunset
  • Articles and FAQ

Integrations


  • Sales
  • Customer Support and Success
  • Finance
  • Tax
  • Marketing
  • Stitch
  • Collaboration
  • Contract Management
  • Order Management
  • Mobile Subscriptions (Legacy)
  • Other Integrations
  • Articles and FAQ

Data Privacy & Security


  • Two Factor Authentication
  • SAML Single Sign-On
  • System for Cross-Domain Identity Management (SCIM)
  • EU-GDPR
  • Consent Management
  • Personal Data Management
  • Compliance Certificates
  • HIPAA Guidelines
  • PCI Recommendations and Integration Types
  • Articles and FAQ

Data Operations


  • Bulk Operations
  • Migration
  • Articles and FAQ
  1. Billing
  2. Data Privacy & Security
  3. System for Cross-Domain Identity Management (SCIM)
  1. Billing
  2. Data Privacy & Security
  3. System for Cross-Domain Identity Management (SCIM)

System for Cross-Domain Identity Management (SCIM)

System for Cross-Domain Identity Management (SCIM) is a standard protocol designed to facilitate the automation of user provisioning and management across various applications and services. SCIM allows organizations to manage user identities in a centralized manner, enabling seamless integration with identity providers and other systems.

With SCIM, organizations can automate the process of creating, updating, and deleting user accounts across multiple platforms, reducing the administrative burden associated with manual user management. This is particularly beneficial for businesses that utilize a variety of applications and need to ensure that user access is consistent and secure.

Benefits

Key benefits of SCIM User Provisioning include:

  • Centralized User Management: Manage user identities from a single source, ensuring consistency across all applications.
  • Automated Provisioning: Automatically create, update, or deactivate user accounts based on organizational changes, such as new hires or role changes.
  • Enhanced Security: Reduce the risk of unauthorized access by ensuring that user accounts are promptly updated or removed as needed.
  • Improved Efficiency: Streamline the onboarding and offboarding processes, allowing IT teams to focus on more strategic initiatives.

Configure SCIM in Chargebee

This guide provides the steps required to how to obtain or configure the SCIM Provisioning on Chargebee, and includes the following topics:

  1. Prerequisites
  2. Provisioning Features
  3. Configuration Steps
  4. Chargebee's Group Name Format

Prerequisites

  • SAML must be enabled before configuring Provisioning for Chargebee.
  • After enabling SAML, you must reach out to Chargebee support to enable Provisioning on your site.

Provisioning Features

The following Provisioning features are supported:

  • Push New Users
  • Push Profile Updates
  • Push User Deactivation
  • Reactivate Users
  • Push Groups
  • Unlink Groups
  • Push Groups or Push Group Updates

Import of Users or Groups from Chargebee to Okta is not supported.

Configuration Steps

Setup in Chargebee

To obtain the API Token value for configuring Provisioning in Chargebee, follow these steps:

  1. Login to your Chargebee account using SAML.

  2. Navigate to Settings > Team Members.

    image
  3. Click Get Started under User Identity Management.

    image
  4. Follow the steps below

    1. Select SCIM and click Next.
    2. Select OKTA and Bearer as authentication type and click Next.
  5. Under Chargebee Credentials, copy the values of the Chargebee Site URL and Bearer Token. Use these values to add SCIM connection at the Provisioning tab of the Chargebee Okta Application.

    image

Setup in Okta

To configure your provisioning settings in the Okta Application, follow these steps:

  1. Login to your Okta account and navigate to Okta admin console.

  2. Select Applications from the left nav.

  3. Select the Chargebee Okta application instance that is configured with SAML for the respective site. This is the instance created while enabling SAML for the site, as mentioned here.

  4. Navigate to Provisioning tab and click Configure API Integration.

    image
  5. Complete the following steps:

    1. Select the Enable API Integration checkbox. Enter your Chargebee API Token from step 5 as mentioned above.
      image
    2. Click Test API Credentials for testing your credentials. This step is optional.
    3. Click Save to apply the changes.
  6. In Provisioning tab, select To App and click Edit to update the Provisioning to App section.

  7. Select and save the following options:

    1. Create Users
    2. Update User Attributes
    3. Deactivate Users
      image
  8. Navigate to the Sign on tab and click Edit to update the Settings section.

  9. Save the application by setting the Application username format to Email under Credential Details.

    image

Chargebee's Group Name Format

Chargebee requires the okta group name to be in the following format:

  • CB/<domain>/ROLE/<role_name>
    • CB is a standard prefix that will not change.
    • domain is your domain name.
    • ROLE is the standard prefix that will not change.
    • role_name is the access role name. For example, Admin, Analyst, and more. Learn more about the access roles preasent in Chargebee.
  • Currently, we do not support the creation of the Owner group, as we have restricted the transfer of owners through SCIM.

Was this article helpful?