The Janssen SCIM 2.0 service (RFC 7642/7643/7644) for cross-domain identity management — users, groups, FIDO 2 devices, bulk operations, and the ServiceProviderConfig / ResourceTypes / Schemas discovery endpoints. 29 operations across 18 paths, with a Gluu user schema extension.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/jans-scim-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.0.1
info:
title: SCIM API
description: |
Janssen SCIM 2.0 server API. Developers can think of SCIM as a REST API with endpoints exposing CRUD functionality
(create, update, retrieve and delete) for identity management resources such as users, groups, and fido devices.
contact:
name: Contact
url: https://github.com/JanssenProject/jans/discussions
license:
name: License
url: https://github.com/JanssenProject/jans/blob/main/LICENSE
version: "OAS Version"
servers:
- url: https://jans.local.io/jans-scim/restv1/v2
tags:
- name: user
description: Endpoints for management of User resources
- name: group
description: Endpoints for management of Group resources
- name: fido2 devices
description: Endpoints for management of Fido2 devices
- name: global search
description: Search from service root
- name: discovery
description: Endpoints to facilitate discovery of SCIM service provider features
paths:
/Groups:
get:
tags:
- group
operationId: get-groups
description: Query Group resources (see section 3.4.2 of RFC 7644)
security:
- scim_oauth: [https://jans.io/scim/groups.read]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
- name: filter
in: query
description: An expression specifying the search criteria. See section 3.4.2.2 of RFC 7644
schema:
type: string
example: displayName co "Audit"
- name: startIndex
in: query
description: The 1-based index of the first query result
schema:
type: integer
- name: count
in: query
description: Specifies the desired maximum number of query results per page
schema:
type: integer
- name: sortBy
in: query
description: The attribute whose value will be used to order the returned responses
schema:
type: string
- name: sortOrder
in: query
description: Order in which the sortBy param is applied. Allowed values are "ascending" and "descending"
schema:
type: string
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/GroupListResponse'
application/json:
schema:
$ref: '#/components/schemas/GroupListResponse'
400:
description: Parameter count exceeds the maximum allowed value or the filter
supplied was unparsable
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- group
operationId: create-group
description: Allows creating a Group resource via POST (see section 3.3 of RFC
7644)
security:
- scim_oauth: [https://jans.io/scim/groups.write]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
requestBody:
description: Payload that represents the Group to create
content:
application/scim+json:
schema:
$ref: '#/components/schemas/GroupResource'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/single/group_minimal_create.json'
application/json:
schema:
$ref: '#/components/schemas/GroupResource'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/single/group_minimal_create.json'
required: true
responses:
201:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/GroupResource'
application/json:
schema:
$ref: '#/components/schemas/GroupResource'
400:
description: An invalid value was passed in the payload
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
409:
description: There is a conflict with an already existing group. Uniqueness
is assumed over displayName
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-codegen-request-body-name: group
/Groups/{id}:
get:
tags:
- group
operationId: get-group-by-id
description: Retrieves a Group resource by Id (see section 3.4.1 of RFC 7644)
security:
- scim_oauth: [https://jans.io/scim/groups.read]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/GroupResource'
application/json:
schema:
$ref: '#/components/schemas/GroupResource'
404:
description: Id passed unknown
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- group
operationId: update-group-by-id
description: "Updates a Group resource (see section 3.5.1 of RFC 7644). Update\
\ works in a replacement fashion: every\nattribute value found in the\
\ payload sent will replace the one in the existing resource representation.\
\ Attributes \nnot passed in the payload will be left intact.\n"
security:
- scim_oauth: [https://jans.io/scim/groups.write]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
description: Payload with the data to replace in the existing group identified
by the id param
content:
application/scim+json:
schema:
$ref: '#/components/schemas/GroupResource'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/single/group_minimal_update.json'
application/json:
schema:
$ref: '#/components/schemas/GroupResource'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/single/group_minimal_update.json'
required: true
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/GroupResource'
application/json:
schema:
$ref: '#/components/schemas/GroupResource'
400:
description: |
An invalid value was passed in the payload or there was an attempt to update an immutable attribute
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
404:
description: Id passed unknown
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
409:
description: There is a conflict with an already existing group. Uniqueness
is assumed over displayName
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-codegen-request-body-name: group
delete:
tags:
- group
operationId: delete-group-by-id
description: Deletes a group resource (see section 3.6 of RFC 7644)
security:
- scim_oauth: [https://jans.io/scim/groups.write]
parameters:
- name: id
in: path
description: Identifier of the resource to delete
required: true
schema:
type: string
responses:
204:
description: Successful operation. Empty response
content: {}
404:
description: Id passed unknown
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
patch:
tags:
- group
operationId: patch-group-by-id
description: "Updates one or more attributes of a Group resource using a sequence\
\ of additions, removals, and replacements operations. See section 3.5.2\
\ of RFC 7644\n"
security:
- scim_oauth: [https://jans.io/scim/groups.write]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
description: Payload describing the patch operations to apply upon the resource
identified by param id
content:
application/scim+json:
schema:
$ref: '#/components/schemas/PatchRequest'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/single/patch/group_patch.json'
application/json:
schema:
$ref: '#/components/schemas/PatchRequest'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/single/patch/group_patch.json'
required: true
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/GroupResource'
application/json:
schema:
$ref: '#/components/schemas/GroupResource'
400:
description: |
One or more operations supplied in the request are specified incorrectly, there were attempts to
modify immutable attributes, or the resulting resource cannot pass intrinsic validations
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-codegen-request-body-name: request
/Groups/.search:
post:
tags:
- group
operationId: search-group
description: Query Group resources (see section 3.4.2 of RFC 7644)
security:
- scim_oauth: [https://jans.io/scim/groups.read]
requestBody:
description: Payload that represents the search criteria
content:
application/scim+json:
schema:
$ref: '#/components/schemas/SearchRequest'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/multiple/search_post_1.json'
application/json:
schema:
$ref: '#/components/schemas/SearchRequest'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/multiple/search_post_1.json'
required: true
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/GroupListResponse'
application/json:
schema:
$ref: '#/components/schemas/GroupListResponse'
400:
description: |
Parameter count exceeds the maximum allowed value, the filter supplied was unparsable,
or invalid schema in search request
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-codegen-request-body-name: searchRequest
/Fido2Devices:
get:
tags:
- fido2 devices
operationId: get-fido2-devices
description: Query Fido 2 resources
security:
- scim_oauth: [https://jans.io/scim/fido2.read]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
- name: userId
in: query
description: Used to restrict the search to fido 2 resources owned by a specific
user
schema:
type: string
- name: filter
in: query
description: An expression specifying the search criteria. See section 3.4.2.2 of RFC 7644
example: userId sw "123-abcde-qwerty"
schema:
type: string
- name: startIndex
in: query
description: The 1-based index of the first query result
schema:
type: integer
- name: count
in: query
description: Specifies the desired maximum number of query results per page
schema:
type: integer
- name: sortBy
in: query
description: The attribute whose value will be used to order the returned responses
schema:
type: string
- name: sortOrder
in: query
description: Order in which the sortBy param is applied. Allowed values are "ascending" and "descending"
schema:
type: string
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/Fido2ListResponse'
application/json:
schema:
$ref: '#/components/schemas/Fido2ListResponse'
400:
description: Parameter count exceeds the maximum allowed value or the filter
supplied was unparsable
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
404:
description: If userId param was supplied and the user is not known
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/Fido2Devices/{id}:
get:
tags:
- fido2 devices
operationId: get-fido2-device-by-id
description: Retrieves a Fido 2 device by Id
security:
- scim_oauth: [https://jans.io/scim/fido2.read]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
- name: userId
in: query
description: Identifier (inum) of the device owner. This param is not required when underlying database is LDAP
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/Fido2DeviceResource'
application/json:
schema:
$ref: '#/components/schemas/Fido2DeviceResource'
404:
description: Id passed unknown
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- fido2 devices
operationId: update-fido2-device-by-id
description: "Updates a Fido 2 resource. Update works in a replacement fashion:\
\ every attribute value found in the payload sent will replace the one in\
\ the existing resource representation. Attributes not passed in the payload\
\ will be left intact.\n"
security:
- scim_oauth: [https://jans.io/scim/fido2.write]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
description: Payload with the data to replace in the existing device identified
by the id param
content:
application/scim+json:
schema:
$ref: '#/components/schemas/Fido2DeviceResource'
application/json:
schema:
$ref: '#/components/schemas/Fido2DeviceResource'
required: true
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/Fido2DeviceResource'
application/json:
schema:
$ref: '#/components/schemas/Fido2DeviceResource'
400:
description: |
An invalid value was passed in the payload or there was an attempt to update an immutable attribute
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
404:
description: Id passed unknown
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-codegen-request-body-name: fido2DeviceResource
delete:
tags:
- fido2 devices
operationId: delete-fido2-device-by-id
description: Deletes a Fido 2 resource
security:
- scim_oauth: [https://jans.io/scim/fido2.write]
parameters:
- name: id
in: path
description: Identifier of the resource to delete
required: true
schema:
type: string
responses:
204:
description: Successful operation. Empty response
content: {}
404:
description: Id passed unknown
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/Fido2Devices/.search:
post:
tags:
- fido2 devices
operationId: search-fido2-device
description: Query Fido 2 resources
security:
- scim_oauth: [https://jans.io/scim/fido2.read]
parameters:
- name: userId
in: query
description: Used to restrict the search to fido 2 resources owned by a specific
user
schema:
type: string
requestBody:
description: Payload that represents the search criteria
content:
application/scim+json:
schema:
$ref: '#/components/schemas/SearchRequest'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/multiple/search_post_2.json'
application/json:
schema:
$ref: '#/components/schemas/SearchRequest'
examples:
samplePayload:
externalValue: 'https://raw.githubusercontent.com/JanssenProject/jans/main/jans-scim/client/src/test/resources/multiple/search_post_2.json'
required: true
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/Fido2ListResponse'
400:
description: |
Parameter count exceeds the maximum allowed value, the filter supplied was unparsable,
or invalid schema in search request
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
404:
description: If userId param was supplied and the user is not known
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-codegen-request-body-name: searchRequest
/Users:
get:
tags:
- user
operationId: get-users
description: Query User resources (see section 3.4.2 of RFC 7644)
security:
- scim_oauth: [https://jans.io/scim/users.read]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
- name: filter
in: query
description: An expression specifying the search criteria. See section 3.4.2.2 of RFC 7644
example: userName eq "jhon" and meta.lastModified gt "2011-05-13T04:42:34Z"
schema:
type: string
- name: startIndex
in: query
description: The 1-based index of the first query result
schema:
type: integer
- name: count
in: query
description: Specifies the desired maximum number of query results per page
schema:
type: integer
- name: sortBy
in: query
description: The attribute whose value will be used to order the returned responses
schema:
type: string
- name: sortOrder
in: query
description: Order in which the sortBy param is applied. Allowed values are "ascending" and "descending"
schema:
type: string
responses:
200:
description: Successful operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/UserListResponse'
application/json:
schema:
$ref: '#/components/schemas/UserListResponse'
400:
description: Parameter count exceeds the maximum allowed value or the filter
supplied was unparsable
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: There was an unexpected failure executing the operation
content:
application/scim+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- user
operationId: create-user
description: Allows creating a User resource via POST (see section 3.3 of RFC
7644)
security:
- scim_oauth: [https://jans.io/scim/users.write]
parameters:
- name: attributes
in: query
description: A comma-separated list of attribute names to return in the response
schema:
type: string
- name: excludedAttributes
in: query
description: When specified, the response will contain a default set of attributes minus those listed here (as a comma-separated list)
schema:
type: string
requestBody:
description: Payload that represents the User to create
content:
application/scim+json:
schema
# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gluu/refs/heads/main/openapi/gluu-jans-scim-openapi.yml