SCIM Group APIs
Overview
This page contains all of the APIs for managing Groups through SCIM Group requests.
Create a Group
This API is used to create a new FusionAuth Group from a SCIM request.
Request
Create a Group from a SCIM request
POST /api/scim/resource/v2/Groups
Where my field definitions at!?!
Because the SCIM specification allows for customization of the schemas using extensions, there is no way to accurately document all the JSON structure possibilities.
The following is just an example of a typical SCIM Group request body a SCIM client might send. However, your incoming request lambda must map these values to populate the FusionAuth Group. A default lambda is provided for you that would handle a request like this example.
This is taken from the SCIM Schema RFC describing a SCIM Group schema. For the full specification you can find the RFC.
Example Request Body
{
"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.
| 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.
Where my field definitions at!?!
Because the SCIM specification allows for customization of the schemas using extensions, there is no way to accurately document all the JSON structure possibilities.
The following is just an example of a typical SCIM Group response body a SCIM client might send. However, your incoming request lambda must map these values to populate the FusionAuth Group. A default lambda is provided for you that would handle a response like this example.
This is taken from the SCIM Schema RFC describing a SCIM Group schema. For the full specification you can find the RFC.
Example Response Body
{
"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 through a SCIM request. 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 through a SCIM request
DELETE /api/scim/resource/v2/Groups/{groupId}
Request Parameters
- groupId [UUID] Optional
-
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.
| 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.
Retrieve a Group
This API is used to retrieve a FusionAuth Group in SCIM schema format through a SCIM request.
Request
Retrieves a Group through a SCIM request
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.
| 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.
Where my field definitions at!?!
Because the SCIM specification allows for customization of the schemas using extensions, there is no way to accurately document all the JSON structure possibilities.
The following is just an example of a typical SCIM Group response body a SCIM client might send. However, your incoming request lambda must map these values to populate the FusionAuth Group. A default lambda is provided for you that would handle a response like this example.
This is taken from the SCIM Schema RFC describing a SCIM Group schema. For the full specification you can find the RFC.
Example Response Body
{
"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
PUT /api/scim/resource/v2/Groups/{groupId}
Request Parameters
- groupId [UUID] Optional
-
The FusionAuth Group Id.
Where my field definitions at!?!
Because the SCIM specification allows for customization of the schemas using extensions, there is no way to accurately document all the JSON structure possibilities.
The following is just an example of a typical SCIM Group request body a SCIM client might send. However, your incoming request lambda must map these values to populate the FusionAuth Group. A default lambda is provided for you that would handle a request like this example.
This is taken from the SCIM Schema RFC describing a SCIM Group schema. For the full specification you can find the RFC.
Example Request Body
{
"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.
| 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.
Where my field definitions at!?!
Because the SCIM specification allows for customization of the schemas using extensions, there is no way to accurately document all the JSON structure possibilities.
The following is just an example of a typical SCIM Group response body a SCIM client might send. However, your incoming request lambda must map these values to populate the FusionAuth Group. A default lambda is provided for you that would handle a response like this example.
This is taken from the SCIM Schema RFC describing a SCIM Group schema. For the full specification you can find the RFC.
Example Response Body
{
"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"]
}