SCIM User APIs

    Overview

    This page contains all of the APIs for managing Users through SCIM User requests.

    Create a User

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

    Request

    Create a User

    URI

    POST /api/scim/resource/v2/Users

    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 User request body. However, your incoming request lambda must map these values the FusionAuth User. 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.1.

    Example Request Body

    Example Request JSON
    
{
  "active": true,
  "emails":[
    {
      "primary": true,
      "type":"work",
      "value":"example@fusionauth.io"
    }
  ],
  "externalId":"cc6714c6-286c-411c-a6bc-ee413cda1dbc",
  "name":{
    "familyName": "Doe",
    "formatted": "John Doe",
    "givenName": "John",
    "honorificPrefix": "Mr.",
    "honorificSuffix": "III",
    "middleName": "William"
  },
  "password": "supersecret",
  "phoneNumbers":[
    {
      "primary": true,
      "type":"mobile",
      "value":"303-555-1234"
    }
  ],
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Users"],
  "userName":"johnny123"
}

    Response

    The response for this API contains the SCIM User. The exact response will be controlled by the configured SCIM Server User request converter lambda function.

    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.

    504

    One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files.

    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 User response body. However, your incoming request lambda must map these values the FusionAuth User. 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.1.

    Example Response JSON
    
{
  "active": true,
  "emails":[
    {
      "primary": true,
      "type":"work",
      "value":"example@fusionauth.io"
    }
  ],
  "externalId":"cc6714c6-286c-411c-a6bc-ee413cda1dbc",
  "id" : "9d222d72-f62b-48c3-a5b7-f2dc934b1ee4",
  "meta" : {
    "created" : "2022-04-08T21:03:32.359Z",
    "lastModified" : "2022-04-08T21:03:32.359Z",
    "location" : "https://piedpiper.com/api/scim/resource/v2/Users/9d222d72-f62b-48c3-a5b7-f2dc934b1ee4",
    "resourceType" : "User"
  },
  "name":{
    "familyName": "Doe",
    "formatted": "John Doe",
    "givenName": "John",
    "honorificPrefix": "Mr.",
    "honorificSuffix": "III",
    "middleName": "William"
  },
  "phoneNumbers":[
    {
      "primary": true,
      "type":"mobile",
      "value":"303-555-1234"
    }
  ],
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Users"],
  "userName":"johnny123"
}

    Retrieve a User

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

    Request

    Retrieves a User

    URI

    GET /api/scim/resource/v2/Users/{userId}

    Request Parameters

    userId [UUID] Optional

    The FusionAuth unique User Id.

    Response

    The response for this API contains the User 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 User response body. However, your incoming request lambda must map these values the FusionAuth User. 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.1.

    Example Response JSON
    
{
  "active": true,
  "emails":[
    {
      "primary": true,
      "type":"work",
      "value":"example@fusionauth.io"
    }
  ],
  "externalId":"cc6714c6-286c-411c-a6bc-ee413cda1dbc",
  "id" : "9d222d72-f62b-48c3-a5b7-f2dc934b1ee4",
  "meta" : {
    "created" : "2022-04-08T21:03:32.359Z",
    "lastModified" : "2022-04-08T21:03:32.359Z",
    "location" : "https://piedpiper.com/api/scim/resource/v2/Users/9d222d72-f62b-48c3-a5b7-f2dc934b1ee4",
    "resourceType" : "User"
  },
  "name":{
    "familyName": "Doe",
    "formatted": "John Doe",
    "givenName": "John",
    "honorificPrefix": "Mr.",
    "honorificSuffix": "III",
    "middleName": "William"
  },
  "phoneNumbers":[
    {
      "primary": true,
      "type":"mobile",
      "value":"303-555-1234"
    }
  ],
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Users"],
  "userName":"johnny123"
}

    Retrieve Users

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

    Request

    Retrieve Users

    URI

    GET /api/scim/resource/v2/Users

    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 phoneNumbers will remove the phoneNumbers attribute from all Users returned in the response.

    filter [String] Optional Available since 1.39.0

    The optional filter string to limit the Users returned to those matching the filter criteria.

    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 User 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 User response body. However, your incoming request lambda must map these values the FusionAuth User. 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.1.

    Example Response JSON
    
{
  "totalResults": 1,
  "itemsPerPage": 25,
  "startIndex": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "active": true,
      "emails":[
        {
          "primary": true,
          "type":"work",
          "value":"example@fusionauth.io"
        }
      ],
      "externalId":"cc6714c6-286c-411c-a6bc-ee413cda1dbc",
      "id" : "9d222d72-f62b-48c3-a5b7-f2dc934b1ee4",
      "meta" : {
        "created" : "2022-04-08T21:03:32.359Z",
        "lastModified" : "2022-04-08T21:03:32.359Z",
        "location" : "https://piedpiper.com/api/scim/resource/v2/Users/9d222d72-f62b-48c3-a5b7-f2dc934b1ee4",
        "resourceType" : "User"
      },
      "name":{
        "familyName": "Doe",
        "formatted": "John Doe",
        "givenName": "John",
        "honorificPrefix": "Mr.",
        "honorificSuffix": "III",
        "middleName": "William"
      },
      "phoneNumbers":[
        {
          "primary": true,
          "type":"mobile",
          "value":"303-555-1234"
        }
      ],
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Users"],
      "userName":"johnny123"
    }
  ]
}

    Update a User

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

    Request

    Updates a User

    URI

    PUT /api/scim/resource/v2/Users/{userId}

    Request Parameters

    userId [UUID] Optional

    The FusionAuth unique User 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 User request body. However, your incoming request lambda must map these values the FusionAuth User. 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.1.

    Example Request Body

    Example Request JSON
    
{
  "active": true,
  "emails":[
    {
      "primary": true,
      "type":"work",
      "value":"example@fusionauth.io"
    }
  ],
  "externalId":"cc6714c6-286c-411c-a6bc-ee413cda1dbc",
  "name":{
    "familyName": "Doe",
    "formatted": "John Doe",
    "givenName": "John",
    "honorificPrefix": "Mr.",
    "honorificSuffix": "III",
    "middleName": "William"
  },
  "password": "supersecret",
  "phoneNumbers":[
    {
      "primary": true,
      "type":"mobile",
      "value":"303-555-1234"
    }
  ],
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Users"],
  "userName":"johnny123"
}

    Response

    The response for this API contains the User 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.

    504

    One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files.

    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 User response body. However, your incoming request lambda must map these values the FusionAuth User. 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.1.

    Example Response JSON
    
{
  "active": true,
  "emails":[
    {
      "primary": true,
      "type":"work",
      "value":"example@fusionauth.io"
    }
  ],
  "externalId":"cc6714c6-286c-411c-a6bc-ee413cda1dbc",
  "id" : "9d222d72-f62b-48c3-a5b7-f2dc934b1ee4",
  "meta" : {
    "created" : "2022-04-08T21:03:32.359Z",
    "lastModified" : "2022-04-08T21:03:32.359Z",
    "location" : "https://piedpiper.com/api/scim/resource/v2/Users/9d222d72-f62b-48c3-a5b7-f2dc934b1ee4",
    "resourceType" : "User"
  },
  "name":{
    "familyName": "Doe",
    "formatted": "John Doe",
    "givenName": "John",
    "honorificPrefix": "Mr.",
    "honorificSuffix": "III",
    "middleName": "William"
  },
  "phoneNumbers":[
    {
      "primary": true,
      "type":"mobile",
      "value":"303-555-1234"
    }
  ],
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Users"],
  "userName":"johnny123"
}

    Delete a User

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

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

    Request

    Delete a User

    URI

    DELETE /api/scim/resource/v2/Users/{userId}

    Request Parameters

    userId [UUID] Required

    The FusionAuth unique User Id.

    Response

    This API does not return a JSON response body.

    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.

    504

    One or more Webhook endpoints returned an invalid response or were unreachable. Based on the transaction configuration for this event your action cannot be completed. A stack trace is provided and logged in the FusionAuth log files.

    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.