• Groups
  • getEndpoint to retrieve a SCIM group by ID.
  • delDeletes an existing SCIM group by ID.
  • putUpdates an existing SCIM group by ID.
  • patchUpdates an existing SCIM group by ID via PATCH operations.
  • getEndpoint to retrieve a List of SCIM groups.
  • postCreate a new SCIM Group.

API docs by Redocly

Absorb SCIM API (v2)

Download OpenAPI specification:Download

Groups

Endpoint to retrieve a SCIM group by ID.

path Parameters

id required

string <guid> Group Identifier.

query Parameters

filter	object The filter for the query request.
sortBy	string Specify the attribute to sort the response by.
sortOrder	string Enum: "Ascending" "Descending" Specify the order to sort the response by.
startIndex	integer <int32> Specify the index to start the response from.
count	integer <int32> Specify how many results to return.
attributes	Array of strings The list of attributes to include in the response.
excludedAttributes	Array of strings The list of attributes to exclude from the response.

Responses

Response Schema: application/json

schemas	Array of strings Group schemas.
id	string <guid> A unique identifier for a SCIM resource as defined by the service provider.
externalId	string A String that is an identifier for the resource as defined by the provisioning client.
displayName	string The display name of the group.
	Array of objects (MemberResponse) Members of the group.
	object Attribute containing resource metadata.

https://{rootUrl}/scim/v2/Groups/{id}

Response samples

• 200
• 404

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "displayName": "string",
• "members": [

  • {

    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com",
    • "type": "User"

    }

  ],
• "meta": {

  • "resourceType": "User",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "location": "http://example.com"

  }

}

Deletes an existing SCIM group by ID.

This is soft delete.

path Parameters

id required

string <guid> Group Identifier.

Responses

https://{rootUrl}/scim/v2/Groups/{id}

Response samples

• 403
• 404
• 409

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "status": "string",
• "scimType": "invalidFilter",
• "detail": "string"

}

Updates an existing SCIM group by ID.

Clients that want to override a server's defaults MAY specify "null" for a single-valued attribute, or an empty array "[]" for a multivalued attribute, to clear all values.

path Parameters

id required

string <guid> The id of group to be updated

Request Body schema: application/json

The request body to update the given group.

schemas	Array of strings Group schemas.
id	string <guid> ID of resource.
externalId	string [ 0 .. 255 ] characters A String that is an identifier for the resource as defined by the provisioning client.
displayName required	string [ 0 .. 255 ] characters The display name of the group. Must be unique.
	Array of objects (MemberRequest) Members of the group.

Responses

Response Schema: application/json

schemas	Array of strings Group schemas.
id	string <guid> A unique identifier for a SCIM resource as defined by the service provider.
externalId	string A String that is an identifier for the resource as defined by the provisioning client.
displayName	string The display name of the group.
	Array of objects (MemberResponse) Members of the group.
	object Attribute containing resource metadata.

https://{rootUrl}/scim/v2/Groups/{id}

Request samples

• Payload

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "displayName": "string",
• "members": [

  • {

    • "value": "string",
    • "type": "string"

    }

  ]

}

Response samples

• 200
• 400
• 409

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "displayName": "string",
• "members": [

  • {

    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com",
    • "type": "User"

    }

  ],
• "meta": {

  • "resourceType": "User",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "location": "http://example.com"

  }

}

Updates an existing SCIM group by ID via PATCH operations.

path Parameters

id required

string <guid> The group's ID.

query Parameters

attributes	Array of strings The list of attributes to include in the response.
excludedAttributes	Array of strings The list of attributes to exclude from the response.

Request Body schema: application/json

The list of patch operations to perform.

schemas required	Array of strings The request schemas.
required	Array of objects (PatchOperation) The list of patch operations

Responses

Response Schema: application/json

schemas	Array of strings Group schemas.
id	string <guid> A unique identifier for a SCIM resource as defined by the service provider.
externalId	string A String that is an identifier for the resource as defined by the provisioning client.
displayName	string The display name of the group.
	Array of objects (MemberResponse) Members of the group.
	object Attribute containing resource metadata.

https://{rootUrl}/scim/v2/Groups/{id}

Request samples

• Payload

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "Operations": [

  • {

    • "op": "string",
    • "path": "string",
    • "value": null

    }

  ]

}

Response samples

• 200
• 400
• 404

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "displayName": "string",
• "members": [

  • {

    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com",
    • "type": "User"

    }

  ],
• "meta": {

  • "resourceType": "User",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "location": "http://example.com"

  }

}

Endpoint to retrieve a List of SCIM groups.

query Parameters

filter	object The filter for the query request.
sortBy	string Specify the attribute to sort the response by.
sortOrder	string Enum: "Ascending" "Descending" Specify the order to sort the response by.
startIndex	integer <int32> Specify the index to start the response from.
count	integer <int32> Specify how many results to return.
attributes	Array of strings The list of attributes to include in the response.
excludedAttributes	Array of strings The list of attributes to exclude from the response.

Responses

Response Schema: application/json

schemas	Array of strings The response schemas.
totalResults	integer <int32> The total number of results returned.
startIndex	integer <int32> The 1-based index of the first result in the current set of search results.
itemsPerPage	integer <int32> The number of results returned on a page.
	Array of objects (GroupResponse) The list of returned resources.

https://{rootUrl}/scim/v2/Groups

Response samples

• 200
• 400

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "totalResults": 0,
• "startIndex": 0,
• "itemsPerPage": 0,
• "Resources": [

  • {

    • "schemas": [

      • "string"

      ],
    • "id": "string",
    • "externalId": "string",
    • "displayName": "string",
    • "members": [

      • {

        • "display": "string",
        • "value": "string",
        • "$ref": "http://example.com",
        • "type": "User"

        }

      ],
    • "meta": {

      • "resourceType": "User",
      • "created": "2019-08-24T14:15:22Z",
      • "lastModified": "2019-08-24T14:15:22Z",
      • "location": "http://example.com"

      }

    }

  ]

}

Create a new SCIM Group.

Request Body schema: application/json

The SCIM Group.

schemas	Array of strings Group schemas.
externalId	string Group ExternalId.
displayName required	string non-empty Name of the group. Must be unique.
	Array of objects (MemberRequest) Members of the group.

Responses

Response Schema: application/json

schemas	Array of strings Group schemas.
id	string <guid> A unique identifier for a SCIM resource as defined by the service provider.
externalId	string A String that is an identifier for the resource as defined by the provisioning client.
displayName	string The display name of the group.
	Array of objects (MemberResponse) Members of the group.
	object Attribute containing resource metadata.

https://{rootUrl}/scim/v2/Groups

Request samples

• Payload

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "externalId": "string",
• "displayName": "string",
• "members": [

  • {

    • "value": "string",
    • "type": "string"

    }

  ]

}

Response samples

• 200
• 400

Content type

application/json

{

• "schemas": [

  • "string"

  ],
• "id": "string",
• "externalId": "string",
• "displayName": "string",
• "members": [

  • {

    • "display": "string",
    • "value": "string",
    • "$ref": "http://example.com",
    • "type": "User"

    }

  ],
• "meta": {

  • "resourceType": "User",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "location": "http://example.com"

  }

}