FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
    • Getting Started
    • 5-minute Setup Guide
      • Overview
      • Docker
      • Fast Path
      • Sandbox
    • Setup Wizard & First Login
    • Register a User and Login
    • Self-service Registration
    • Start and Stop FusionAuth
    • Core Concepts
      • Overview
      • Users
      • Roles
      • Groups
      • Registrations
      • Applications
      • Tenants
      • Identity Providers
      • Authentication/Authorization
      • Integration Points
    • Example Apps
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • PHP
      • Python
      • Ruby
    • Tutorials
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kubernetes
      • Overview
      • Deployment Guide
      • Minikube Setup
      • Amazon EKS Setup
      • Google GKE Setup
      • Microsoft AKS Setup
    • Kickstart™
    • Homebrew
    • Marketplaces
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Microsoft Azure AD B2C
    • Tutorial
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Editions and Features
    • Key Rotation
    • Licensing
    • Monitoring
    • Prometheus Setup
    • Proxy Setup
    • Reference
      • Overview
      • Configuration
      • CORS
      • Data Types
      • Hosted Login Pages Cookies
      • Known Limitations
      • Password Hashes
    • Releases
    • Roadmap
    • Search And FusionAuth
    • Securing
    • Switch Search Engines
    • Technical Support
    • Troubleshooting
    • Upgrading
    • WebAuthn
  • Login Methods
    • Identity Providers
      • Overview
      • Apple
      • Epic Games
      • External JWT
        • Overview
        • Example
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
        • Overview
        • Amazon Cognito
        • Azure AD
        • Discord
        • Github
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • SAML v2
        • Overview
        • ADFS
        • Azure AD
      • SAML v2 IdP Initiated
        • Overview
        • Okta
      • Xbox
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
      • OAuth Modes
    • Passwordless
      • Overview
      • Magic Links
      • WebAuthn & Passkeys
    • SAML v2 IdP
      • Overview
      • Google
      • Zendesk
  • Developer Guide
    • Overview
    • API Gateways
      • Overview
      • ngrok Cloud Edge
    • Client Libraries & SDKs
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • Node
      • OpenAPI
      • PHP
      • Python
      • React
      • Ruby
      • Typescript
    • Events & Webhooks
      • Overview
      • Writing a Webhook
      • Securing Webhooks
      • Events
        • Overview
        • Audit Log Create
        • Event Log Create
        • JWT Public Key Update
        • JWT Refresh
        • JWT Refresh Token Revoke
        • Kickstart Success
        • Group Create
        • Group Create Complete
        • Group Delete
        • Group Delete Complete
        • Group Update
        • Group Update Complete
        • Group Member Add
        • Group Member Add Complete
        • Group Member Remove
        • Group Member Remove Complete
        • Group Member Update
        • Group Member Update Complete
        • User Action
        • User Bulk Create
        • User Create
        • User Create Complete
        • User Deactivate
        • User Delete
        • User Delete Complete
        • User Email Update
        • User Email Verified
        • User IdP Link
        • User IdP Unlink
        • User Login Failed
        • User Login Id Dup. Create
        • User Login Id Dup. Update
        • User Login New Device
        • User Login Success
        • User Login Suspicious
        • User Password Breach
        • User Password Reset Send
        • User Password Reset Start
        • User Password Reset Success
        • User Password Update
        • User Reactivate
        • User Reg. Create
        • User Reg. Create Complete
        • User Reg. Delete
        • User Reg. Delete Complete
        • User Registration Update
        • User Reg. Update Complete
        • User Reg. Verified
        • User 2FA Method Add
        • User 2FA Method Remove
        • User Update
        • User Update Complete
    • Guides
      • Overview
      • Authentication Tokens
      • Exposing A Local Instance
      • JSON Web Tokens
      • Key Master
      • Localization and Internationalization
      • Multi-Factor Authentication
      • Multi-Tenant
      • Passwordless
      • Registration-based Email Verification
      • Searching With Elasticsearch
      • Securing Your APIs
      • Silent Mode
      • Single Sign-on
      • Two Factor (pre 1.26)
    • Integrations
      • Overview
      • CleanSpeak
      • Kafka
      • Twilio
    • Plugins
      • Overview
      • Writing a Plugin
      • Custom Password Hashing
    • User Control & Gating
      • Overview
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
  • Customization
    • Email & Templates
      • Overview
      • Configure Email
      • Email Templates
      • Email Variables
      • Message Templates
    • Lambdas
      • Overview
      • Apple Reconcile
      • Client Cred. JWT Populate
      • Epic Games Reconcile
      • External JWT Reconcile
      • Facebook Reconcile
      • Google Reconcile
      • HYPR Reconcile
      • JWT Populate
      • LDAP Connector Reconcile
      • LinkedIn Reconcile
      • Nintendo Reconcile
      • OpenID Connect Reconcile
      • SAML v2 Populate
      • SAML v2 Reconcile
      • SCIM Group Req. Converter
      • SCIM Group Resp. Convtr.
      • SCIM User Req. Converter
      • SCIM User Resp. Converter
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
  • Premium Features
    • Overview
    • Advanced Registration Forms
    • Advanced Threat Detection
    • Application Specific Themes
    • Breached Password Detection
    • Connectors
      • Overview
      • Generic Connector
      • LDAP Connector
      • FusionAuth Connector
    • Entity Management
    • SCIM
      • Overview
      • Azure AD Client
      • Okta Client
      • SCIM-SDK
    • Self Service Account Mgmt
      • Overview
      • Updating User Data & Password
      • Add Two-Factor Authenticator
      • Add Two-Factor Email
      • Add Two-Factor SMS
      • Add WebAuthn Passkey
      • Customizing
      • Troubleshooting
    • WebAuthn
  • APIs
    • Overview
    • Authentication
    • Errors
    • API Explorer
    • Actioning Users
    • API Keys
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consents
    • Emails
    • Entity Management
      • Overview
      • Entities
      • Entity Types
      • Grants
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Links
      • Apple
      • External JWT
      • Epic Games
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
      • SAML v2
      • SAML v2 IdP Initiated
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • Xbox
    • Integrations
    • IP Access Control Lists
    • JWT
    • Keys
    • Lambdas
    • Login
    • Message Templates
    • Messengers
      • Overview
      • Generic
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM User
      • SCIM Group
      • SCIM EnterpriseUser
      • SCIM Service Provider Config.
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • WebAuthn
    • Webhooks
  • Release Notes

    SCIM Group APIs

    FusionAuth Reactor logo

    This feature is only available in the Enterprise plan. Please visit our pricing page to learn more.

    Overview

    This page contains all of the APIs for managing Groups through SCIM Group requests.

    • Create a Group

    • Retrieve a Group

    • Retrieve Groups

    • Update a Group

    • Delete a Group

    Create a Group

    This API is intended to be called by a SCIM Client and is used to create a new FusionAuth Group.

    Request

    Create a Group

    URI

    POST /api/scim/resource/v2/Groups

    The SCIM specification allows for customization of the schemas using extensions. Therefore, it is not possible to accurately document all the possible variations.

    The following is an example of a typical SCIM Group request body. However, your incoming request lambda must map these values the FusionAuth Group. A default lambda is provided to handle a typical request that you may modify if necessary.

    This example is taken from RFC 7643 Section #4.2.

    Example Request Body

    Example Request JSON
    
    {
      "externalId" : "2819c223-7f76-453a-919d-413861904646",
      "displayName": "Sales Reps",
      "members": [
        {
          "displayName": "John Doe",
          "$ref": "https://login.piedpiper.com/api/scim/v2/Users/902c246b-6245-4190-8e05-00816be7344a",
          "value": "902c246b-6245-4190-8e05-00816be7344a"
        }
      ],
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"]
    }

    Response

    The response for this API contains the Group that was just created in SCIM schema format.

    Table 1. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain a SCIM Error JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid JWT in your Authorization header. The response will be empty. Ensure you’ve correctly set up Entities and performed a Client Credentials grant.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    For FusionAuth SCIM endpoints, any error responses will be returned in standard SCIM schema. See more details in the SCIM API Overview.

    Example Response Body

    The SCIM specification allows for customization of the schemas using extensions. Therefore, it is not possible to accurately document all the possible variations.

    The following is an example of a typical SCIM Group response body. However, your incoming request lambda must map these values the FusionAuth Group. A default lambda is provided to handle a typical response that you may modify if necessary.

    This example is taken from RFC 7643 Section #4.2.

    Example Response JSON
    
    {
      "id": "2819c223-7f76-453a-919d-413861904600",
      "externalId": "2819c223-7f76-453a-919d-413861904646",
      "displayName": "Sales Reps",
      "members": [
        {
          "displayName": "John Doe",
          "$ref": "https://login.piedpiper.com/api/scim/v2/Users/902c246b-6245-4190-8e05-00816be7344a",
          "value": "902c246b-6245-4190-8e05-00816be7344a"
        }
      ],
      "meta":{
        "created": "2022-01-23T04:56:22Z",
        "lastModified": "2022-03-13T04:42:34Z",
        "location":"https://login.piedpiper.com/api/scim/v2/Groups/2819c223-7f76-453a-919d-413861904600",
        "resourceType": "Group"
      },
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"]
    }

    Retrieve a Group

    This API is used to retrieve a FusionAuth Group in SCIM schema format through a SCIM request.

    Request

    Retrieves a Group

    URI

    GET /api/scim/resource/v2/Groups/{groupId}

    Request Parameters

    groupId [UUID] Optional

    The FusionAuth unique Group Id.

    Response

    The response for this API contains the Group in SCIM schema format.

    Table 2. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain a SCIM Error JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid JWT in your Authorization header. The response will be empty. Ensure you’ve correctly set up Entities and performed a Client Credentials grant.

    404

    The object doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    For FusionAuth SCIM endpoints, any error responses will be returned in standard SCIM schema. See more details in the SCIM API Overview.

    Example Response Body

    The SCIM specification allows for customization of the schemas using extensions. Therefore, it is not possible to accurately document all the possible variations.

    The following is an example of a typical SCIM Group response body. However, your incoming request lambda must map these values the FusionAuth Group. A default lambda is provided to handle a typical response that you may modify if necessary.

    This example is taken from RFC 7643 Section #4.2.

    Example Response JSON
    
    {
      "id": "2819c223-7f76-453a-919d-413861904600",
      "externalId": "2819c223-7f76-453a-919d-413861904646",
      "displayName": "Sales Reps",
      "members": [
        {
          "displayName": "John Doe",
          "$ref": "https://login.piedpiper.com/api/scim/v2/Users/902c246b-6245-4190-8e05-00816be7344a",
          "value": "902c246b-6245-4190-8e05-00816be7344a"
        }
      ],
      "meta":{
        "created": "2022-01-23T04:56:22Z",
        "lastModified": "2022-03-13T04:42:34Z",
        "location":"https://login.piedpiper.com/api/scim/v2/Groups/2819c223-7f76-453a-919d-413861904600",
        "resourceType": "Group"
      },
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"]
    }

    Retrieve Groups

    This API is used to retrieve a paginated set of Groups with an optional filter.

    Request

    Retrieve Groups

    URI

    GET /api/scim/resource/v2/Groups

    Request Parameters

    count [Integer] Optional

    The number of results to return. Used for pagination.

    excludedAttributes [String] Optional Available since 1.39.0

    A comma separated list of one or more attributes to exclude in the JSON response body.

    For example, a value of members will remove the members attribute from all Groups returned in the response.

    filter [String] Optional Available since 1.39.0

    The SCIM filter string used to limit the Groups returned to those matching the criteria.

    The use of this parameter is limited when using to filter Groups. The following limitations apply:

    • Only the displayName and externalId attributes may be used

    • Only the eq operator may be used

    startIndex [Integer] Optional

    The offset into the total results. In order to paginate the results, increment this value by the count for subsequent requests.

    This parameter begins at 1.

    Response

    The response for this API contains the Groups in SCIM schema format.

    Table 3. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain a SCIM Error JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid JWT in your Authorization header. The response will be empty. Ensure you’ve correctly set up Entities and performed a Client Credentials grant.

    404

    The object doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    For FusionAuth SCIM endpoints, any error responses will be returned in standard SCIM schema. See more details in the SCIM API Overview.

    Example Response Body

    The SCIM specification allows for customization of the schemas using extensions. Therefore, it is not possible to accurately document all the possible variations.

    The following is an example of a typical SCIM Group response body. However, your incoming request lambda must map these values the FusionAuth Group. A default lambda is provided to handle a typical response that you may modify if necessary.

    This example is taken from RFC 7643 Section #4.2.

    Example Response JSON
    
    {
      "totalResults": 1,
      "itemsPerPage": 25,
      "startIndex": 1,
      "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
      ],
      "Resources": [
        {
          "id": "2819c223-7f76-453a-919d-413861904600",
          "externalId": "2819c223-7f76-453a-919d-413861904646",
          "displayName": "Sales Reps",
          "members": [
            {
              "displayName": "John Doe",
              "$ref": "https://login.piedpiper.com/api/scim/v2/Users/902c246b-6245-4190-8e05-00816be7344a",
              "value": "902c246b-6245-4190-8e05-00816be7344a"
            }
          ],
          "meta":{
            "created": "2022-01-23T04:56:22Z",
            "lastModified": "2022-03-13T04:42:34Z",
            "location":"https://login.piedpiper.com/api/scim/v2/Groups/2819c223-7f76-453a-919d-413861904600",
            "resourceType": "Group"
          },
          "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"]
        }
      ]
    }

    Update a Group

    This API is used to update a new FusionAuth Group from a SCIM request. The FusionAuth Group will be overwritten with only the data contained in the request. It is not a partial update or patch.

    Request

    Updates a Group from a SCIM request

    URI

    PUT /api/scim/resource/v2/Groups/{groupId}

    Request Parameters

    groupId [UUID] Optional

    The FusionAuth Group Id.

    The SCIM specification allows for customization of the schemas using extensions. Therefore, it is not possible to accurately document all the possible variations.

    The following is an example of a typical SCIM Group request body. However, your incoming request lambda must map these values the FusionAuth Group. A default lambda is provided to handle a typical request that you may modify if necessary.

    This example is taken from RFC 7643 Section #4.2.

    Example Request Body

    Example Request JSON
    
    {
      "externalId" : "2819c223-7f76-453a-919d-413861904646",
      "displayName": "Sales Reps",
      "members": [
        {
          "displayName": "John Doe",
          "$ref": "https://login.piedpiper.com/api/scim/v2/Users/902c246b-6245-4190-8e05-00816be7344a",
          "value": "902c246b-6245-4190-8e05-00816be7344a"
        }
      ],
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"]
    }

    Response

    The response for this API contains the Group that was updated in SCIM schema format.

    Table 4. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain a SCIM Error JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid JWT in your Authorization header. The response will be empty. Ensure you’ve correctly set up Entities and performed a Client Credentials grant.

    404

    The object doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    For FusionAuth SCIM endpoints, any error responses will be returned in standard SCIM schema. See more details in the SCIM API Overview.

    Example Response Body

    The SCIM specification allows for customization of the schemas using extensions. Therefore, it is not possible to accurately document all the possible variations.

    The following is an example of a typical SCIM Group response body. However, your incoming request lambda must map these values the FusionAuth Group. A default lambda is provided to handle a typical response that you may modify if necessary.

    This example is taken from RFC 7643 Section #4.2.

    Example Response JSON
    
    {
      "id": "2819c223-7f76-453a-919d-413861904600",
      "externalId": "2819c223-7f76-453a-919d-413861904646",
      "displayName": "Sales Reps",
      "members": [
        {
          "displayName": "John Doe",
          "$ref": "https://login.piedpiper.com/api/scim/v2/Users/902c246b-6245-4190-8e05-00816be7344a",
          "value": "902c246b-6245-4190-8e05-00816be7344a"
        }
      ],
      "meta":{
        "created": "2022-01-23T04:56:22Z",
        "lastModified": "2022-03-13T04:42:34Z",
        "location":"https://login.piedpiper.com/api/scim/v2/Groups/2819c223-7f76-453a-919d-413861904600",
        "resourceType": "Group"
      },
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"]
    }

    Delete a Group

    This API is used to hard delete a FusionAuth Group. You must specify the Id of the Group on the URI.

    The data of a Group who has been hard deleted is permanently removed from FusionAuth. The Group’s data cannot be restored via the FusionAuth API or the administrative Group interface. If you need to restore the Group’s data, you must retrieve it from a database backup.

    Request

    Delete a Group

    URI

    DELETE /api/scim/resource/v2/Groups/{groupId}

    Request Parameters

    groupId [UUID] Required

    The FusionAuth unique Group Id.

    Response

    This API does not return a JSON response body.

    The DELETE endpoint will return a 204 status code upon success or one of the standard error status codes.

    Table 5. Response Codes
    Code Description

    204

    The request was successful. The response will be empty.

    400

    The request was invalid and/or malformed. The response will contain a SCIM Error JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid JWT in your Authorization header. The response will be empty. Ensure you’ve correctly set up Entities and performed a Client Credentials grant.

    404

    The object doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    503

    The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

    For FusionAuth SCIM endpoints, any error responses will be returned in standard SCIM schema. See more details in the SCIM API Overview.

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.

    © 2023 FusionAuth
    Subscribe for developer updates