SCIM API Revision History

This page documents the changes made to the SCIM REST API for each version.

The YAML versioning is controlled by three digits in the 1.2.3 format where:

1 - the first digit represents major breaking changes such as new or updated mandatory attributes

2 - the second digit represents major non-breaking changes such as new features, optional attributes or endpoints

3 - the third digit represents minor changes such as fixes for description, typos or unused attributes

Version 10.1.0

Release date: 28 June 2024

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details

/Credential/Type

UPDATED Added details for the following credential types:

  • urn:hid:scim:api:idp:2.0:credential:type:OOBACode

  • urn:hid:scim:api:idp:2.0:credential:type:FIDO

  • urn:hid:scim:api:idp:2.0:credential:type:PKICert

/AuditRecords

UPDATED Modified endpoint:

  • [GET, .search] - updated the comparison operators

  • Added custom action parameters TEXT1 to TEXT10 when creating or filtering audit records
/Device UPDATED The type filter is no longer required when using the status.expiryDate filter
/Organization

UPDATED The startIndex and count parameters are no longer supported for GET and .search
/Custo UPDATED Added support for userID-less authentication (scan to approve) to the sample payloads

Version 10.0.0

Release date: 25 March 2024

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details

/Device/Type

UPDATED Modified endpoint:

  • Removed keysProtectionPolicies.bioPolicy and urlOperationValidation from device:type:Push

  • Added the forceInstallation attribute to device:type:Push

/AuditRecords

UPDATED [POST] /AuditRecords - the following immutable parameters are no longer supported when creating an audit record:

  • targetUserId.id

  • targetUserId.tenantId

  • targetUserId.session

Version 9.2.0

Release date: 28 June 2024

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details

/Credential/Type

UPDATED Added details for the following credential types:

  • urn:hid:scim:api:idp:2.0:credential:type:OOBACode

  • urn:hid:scim:api:idp:2.0:credential:type:FIDO

  • urn:hid:scim:api:idp:2.0:credential:type:PKICert

/AuditRecords

UPDATED Modified endpoint:

  • [GET, .search] - updated the comparison operators

  • Added custom action parameters TEXT1 to TEXT10 when creating or filtering audit records
/Device UPDATED The type filter is no longer required when using the status.expiryDate filter
/Custo UPDATED Added support for userID-less authentication (scan to approve) to the sample payloads

Version 9.1.0

Release date: 25 March 2024

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/Users UPDATED [PUT] /Users - added support of the 'attributes' query string parameter when updating a user
/AuditRecords UPDATED Improved schema and descriptions
/Credential/Type

UPDATED Modified endpoint - added the:

  • Extension for the OOB credential type

  • Optional OCRA modes attribute for the Push OATH credential type

  • Optional keyUsage attribute for the Push OATH credential type

Version 9.0.0

Release date: 13 December 2023

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/User/AttributeType

UPDATED Modified endpoint:

  • Added support for multiple values in custom user attributes (multiValued)

  • Updated the create HTTP status

  • Fixed minor syntax issues
/Users UPDATED Added support for multiple values in custom user attributes (multiValued)
/Groups UPDATED Fixed minor syntax issues

Version 8.0.0

Release date: 06 October 2023

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/Device/Type

UPDATED Modified endpoint to add the following parameters for the push Device Types:

  • transactionHistory

  • pushNotif

/Authenticator

UPDATED Modified endpoint:

  • Fixed maxLength for password

  • Added lastSuccessfulDevice property in schemas and examples for Device
/DeliveryGateway UPDATED Added notes property in schemas and examples
/Users UPDATED Added roles and urn:ietf:params:scim:schemas:extension:enterprise:2.0:User to the list of supported requested attributes
General Fixed minor syntax issues

Version 7.0.0

Release date: 31 March 2023

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/AuditRecords UPDATED [POST] /AuditRecords/.search - updated search and sorting
/Users

UPDATED Modified endpoint:

  • [POST] /Users/.search - updated search and sorting

  • Updated schema extension to include additional device information (GET, POST):

    • Last time the device was used for authentication for each device listed (lastSuccessfulDate)

    • Last policy used with this device during authentication (lastSuccessfulAuthPolicy)

Version 6.1.0

Release date: 13 January 2023

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/Credential/Type UPDATED Added push credential types (PushPKI, PushOATH, PushSMK, PushOOB)
/AuditRecords UPDATED Updated schema
General Clarified the use of the API version in requests.

Version 6.0.1

Release date: 15 December 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/DeliveryGateway UPDATED Added appId parameter in Push Delivery Gateways
General

  • Updated the default API version from 4 to 6

  • Updated description and examples

Version 6.0.0

Release date: 14 October 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/Device UPDATED [/Device/Type] - fixed typo in extension descriptions
/Authenticator UPDATED [PUT] [/Authenticator/{uid}] - fixed examples to remove status.startDate and status.expiryDate because they are immutable
/Authenticator UPDATED Modified endpoint:

  • Added default, minimum and maximum values as examples

  • Replaced Credential extension with new extensions for each type of AT (Push extension, OTP extension, OOB extension, etc)
/Credential/Type UPDATED Added default, minimum and maximum values as examples
/Device/Type UPDATED Modified endpoint:

  • Added Application ID parameter

  • Added default, minimum and maximum values as examples
General

  • Added examples for path/query parameters

  • Added descriptions for path/query parameters

  • Fixed 409 CONFLICT response

Version 5.0.1

Release date: 30 May 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/AuditRecords UPDATED [POST] /AuditRecords/.search - fixed calls
/Credential UPDATED Modified endpoint:

  • [POST] /Credential/.search - fixed calls

  • Added REVOKED, SUSPENDED and TERMINATED statuses
/Device UPDATED Modified endpoint:

  • [POST] /Device/.search - fixed calls

  • [POST] /Device/.import - added encryptionKey

  • Added REVOKED, SUSPENDED and TERMINATED statuses
/Device/Provision UPDATED [POST] /Device/Provision/.search - fixed calls
/Group UPDATED [POST] /Group/.search - fixed calls
/Organization UPDATED [POST] /Organization/.search - fixed calls
/ResourceTypes UPDATED Fixed schema extensions
General Fixed typos

Version 5.0.0

Release date: 13 May 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
General Fix for OneOf instances on multiple endpoints

Version 4.1.1

Release date: 25 April 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/AuditRecords UPDATED [POST] Fixed the "default" value
/Credential UPDATED [GET] Changed "\$ref" to "$ref"
/User UPDATED [GET] Fixed "type" of "value" for "urn:hid:scim:api:idp:2.0:UserAttribute" from "number" to "string"
/Device

UPDATED Added missing "friendlyName" for:

  • [POST]

  • [PUT]
General Modified YAML title

Version 4.1.0

Release date: 04 March 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/Device

UPDATED Added:

  • [POST] /device/id response details

  • Create task

  • Details for request/responses
/DeliveryGateway

UPDATED Added delivery gateways for:

  • Email - /configuration/{tenant}/v2/DeliveryGateway/Email

  • SMS - /configuration/{tenant}/v2/DeliveryGateway/SMS

Updated /configuration/{tenant}/v2/DeliveryGateway/Push
/Custo NEW Endpoint for customization

General

Fixed typos

Version 4.0.0

Release date: 03 January 2022

Compatibility:

  • HID Authentication Service

Download YAML