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 Service Provider API Overview

    FusionAuth Reactor logo

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

    Overview

    This API is used to retrieve information about the configuration of the FusionAuth SCIM Service Provider as specified in the RFC.

    • Retrieve Resource Types

    • Retrieve Schemas

    • Retrieve Service Provider Configuration

    Retrieve Resource Types

    Request

    Retrieve All Resource Types

    URI

    GET /api/scim/resource/v2/ResourceTypes

    Retrieve a Resource Type by Id

    URI

    GET /api/scim/resource/v2/ResourceTypes/{resourceTypeId}

    Request Parameters

    resourceTypeId [String] Optional

    The unique Resource Type Id, such as User.

    Response

    The response for this API contains the ResourceType(s) in standard SCIM schema.

    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.

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

    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 the default response body. However, you can customize the schemas portion of the response by modifying the schemas setting.

    This is taken from the SCIM RFC describing a SCIM ResourceTypes schema. For the full specification you can find the RFC.

    Response Body

    Default Response JSON
    
    {
      "itemsPerPage": 10,
      "Resources": [
        {
          "description": "User Account",
          "endpoint": "/Users",
          "id": "User",
          "meta": {
            "location": "https://piedpiper.com/api/scim/v2/ResourceTypes/User",
            "resourceType": "ResourceType"
          },
          "name": "User",
          "schema": "urn:ietf:params:scim:schemas:core:2.0:User",
          "schemaExtensions": [
            {
              "required": true,
              "schema": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
            }
          ],
          "schemas": [
            "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
          ]
        },
        {
          "description": "Group",
          "endpoint": "/Groups",
          "id": "Group",
          "meta": {
            "location": "https://piedpiper.com/api/scim/v2/ResourceTypes/Group",
            "resourceType": "ResourceType"
          },
          "name": "Group",
          "schema": "urn:ietf:params:scim:schemas:core:2.0:Group",
          "schemas": [
            "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
          ]
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
      ],
      "startIndex": 1,
      "totalResults": 2
    }

    Retrieve Schemas

    Request

    Retrieve All Schemas

    URI

    GET /api/scim/resource/v2/Schemas

    Retrieve a Schema by Id

    URI

    GET /api/scim/resource/v2/Schemas/{schemaId}

    Request Parameters

    schemaId [String] Optional

    The unique Schema Id, such as urn:ietf:params:scim:schemas:core:2.0:User.

    Response

    The response for this API contains the Schema definition(s) in standard SCIM schema.

    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.

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

    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 the default response body. However, you can customize this response by modifying the Tenant’s schemas setting.

    This example is taken from RFC 7643 section #7.

    Response Body

    Default Response JSON
    
    {
      "itemsPerPage": 4,
      "Resources": [
        {
          "attributes": [],
          "description": "Enterprise User",
          "id": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
          "meta": {
            "location": "https://piedpiper.com/api/scim/resource/v2/Schemas/v2/Schemas/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
            "resourceType": "Schema"
          },
          "name": "EnterpriseUser"
        },
        {
          "attributes": [
            {
              "caseExact": false,
              "description": "A human-readable name for the Group. REQUIRED.",
              "multiValued": false,
              "mutability": "readWrite",
              "name": "displayName",
              "required": false,
              "returned": "default",
              "type": "string",
              "uniqueness": "none"
            },
            {
              "description": "A list of members of the Group.",
              "multiValued": true,
              "mutability": "readWrite",
              "name": "members",
              "required": false,
              "returned": "default",
              "subAttributes": [
                {
                  "caseExact": false,
                  "description": "Identifier of the member of this Group.",
                  "multiValued": false,
                  "mutability": "immutable",
                  "name": "value",
                  "required": false,
                  "returned": "default",
                  "type": "string",
                  "uniqueness": "none"
                },
                {
                  "caseExact": false,
                  "description": "The URI corresponding to a SCIM resource that is a member of this Group.",
                  "multiValued": false,
                  "mutability": "immutable",
                  "name": "$ref",
                  "referenceTypes": [
                    "Group",
                    "User"
                  ],
                  "required": false,
                  "returned": "default",
                  "type": "reference",
                  "uniqueness": "none"
                }
              ],
              "type": "complex"
            }
          ],
          "description": "Group",
          "id": "urn:ietf:params:scim:schemas:core:2.0:Group",
          "meta": {
            "location": "https://piedpiper.com/api/scim/resource/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group",
            "resourceType": "Schema"
          },
          "name": "Group"
        },
        {
          "attributes": [
            {
              "caseExact": false,
              "description": "Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. REQUIRED.",
              "multiValued": false,
              "mutability": "readWrite",
              "name": "userName",
              "required": true,
              "returned": "default",
              "type": "string",
              "uniqueness": "server"
            },
            {
              "description": "A Boolean value indicating the User's administrative status.",
              "multiValued": false,
              "mutability": "readWrite",
              "name": "active",
              "required": false,
              "returned": "default",
              "type": "boolean"
            }
          ],
          "description": "User Account",
          "id": "urn:ietf:params:scim:schemas:core:2.0:User",
          "meta": {
            "location": "https://piedpiper.com/api/scim/resource/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User",
            "resourceType": "Schema"
          },
          "name": "User"
        },
        {
          "attributes": [
            {
              "description": "A list of field errors.",
              "multiValued": true,
              "mutability": "immutable",
              "name": "fieldErrors",
              "required": false,
              "returned": "default",
              "subAttributes": [
                {
                  "attributes": [
                    {
                      "caseExact": false,
                      "description": "The Fusion Auth error code",
                      "multiValued": false,
                      "mutability": "immutable",
                      "name": "code",
                      "required": false,
                      "returned": "default",
                      "type": "string",
                      "uniqueness": "none"
                    },
                    {
                      "caseExact": false,
                      "description": "The Fusion Auth error message",
                      "multiValued": false,
                      "mutability": "immutable",
                      "name": "message",
                      "required": false,
                      "returned": "default",
                      "type": "string",
                      "uniqueness": "none"
                    }
                  ],
                  "description": "A list of field errors.",
                  "multiValued": true,
                  "mutability": "immutable",
                  "name": "object.fieldName",
                  "required": false,
                  "returned": "default"
                }
              ],
              "type": "complex"
            },
            {
              "description": "A list of general errors.",
              "multiValued": true,
              "mutability": "immutable",
              "name": "generalErrors",
              "required": false,
              "returned": "default",
              "subAttributes": [
                {
                  "caseExact": false,
                  "description": "The Fusion Auth error code",
                  "multiValued": false,
                  "mutability": "immutable",
                  "name": "code",
                  "required": false,
                  "returned": "default",
                  "type": "string",
                  "uniqueness": "none"
                },
                {
                  "caseExact": false,
                  "description": "The Fusion Auth error data",
                  "multiValued": true,
                  "mutability": "immutable",
                  "name": "data",
                  "required": false,
                  "returned": "default",
                  "type": "complex",
                  "uniqueness": "none"
                },
                {
                  "caseExact": false,
                  "description": "The Fusion Auth error message",
                  "multiValued": false,
                  "mutability": "immutable",
                  "name": "message",
                  "required": false,
                  "returned": "default",
                  "type": "string",
                  "uniqueness": "none"
                }
              ],
              "type": "complex"
            }
          ],
          "description": "FusionAuth Errors",
          "id": "urn:ietf:params:scim:schemas:extension:fusionauth:2.0:Error",
          "meta": {
            "location": "https://piedpiper.com/api/scim/resource/v2/Schemas/urn:ietf:params:scim:schemas:extension:fusionauth:2.0:Error",
            "resourceType": "Schema"
          },
          "name": "FusionAuthError"
        }
      ],
      "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:ListResponse"
      ],
      "startIndex": 1,
      "totalResults": 4
    }

    Retrieve Service Provider Configuration

    Request

    Retrieve Service Provider Configuration

    URI

    GET /api/scim/resource/v2/ServiceProviderConfig

    Response

    The response for this API contains the Service Provider Configuration in standard SCIM schema.

    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.

    500

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

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

    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 response body is taken from the SCIM RFC describing a SCIM Service Provider Configuration schema. For the full specification you can find the RFC.

    Response Body

    Response JSON
    
    {
      "authenticationSchemes": [
        {
          "description": "Authentication scheme using the OAuth Bearer Token Standard",
          "name": "OAuth2 Bearer Token",
          "primary": true,
          "specUri": "http://www.rfc-editor.org/info/rfc6750",
          "type": "oauthbearertoken"
        }
      ],
      "bulk": {
        "supported": false
      },
      "changePassword": {
        "supported": true
      },
      "etag": {
        "supported": false
      },
      "filter": {
        "maxResults": 500,
        "supported": false
      },
      "meta": {
        "location": "https://piedpiper.com/api/scim/resource/v2/ServiceProviderConfig",
        "resourceType": "ServiceProviderConfig"
      },
      "patch": {
        "supported": false
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
      ],
      "sort": {
        "supported": false
      }
    }

    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