OpenID API Revision History

This page documents the changes made to the OpenID 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 1.6.0

Release date: 10 October 2024

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/code UPDATED Added the card grant type for smart card authentication
/enroll/card NEW Endpoint to enroll smart cards
/.well-known/openid-configuration

UPDATED Added new parameters for integration support:

  • Supported response types:

    • id_token

  • Supported response modes:

    • form_post

  • Supported claims:

    • amr

/register UPDATED Added the id_token_hint_issuers parameter to allow an array of external issuers from which the id_token_hint can be accepted

Version 1.5.0

Release date: 28 June 2024

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/code UPDATED Added support for UserID-less Authentication
/logout NEW Endpoint to provide end-user logout

Version 1.4.0

Release date: 25 March 2024

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/register UPDATED Added the optional hid_client_authentication_constraints parameter allowing to define an IP whitelist to block DDoS attacks

Version 1.3.0

Release date: 13 December 2023

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/token UPDATED [POST] [/authn/token] Updated id_token example with multivalued user attribute as claims
/code UPDATED [POST] [/authn/code] Added support for FIDO passkeys
/enroll UPDATED [POST] [/authn/enroll/fido] Added support for FIDO passkeys

Version 1.2.0

Release date: 06 October 2023

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/token UPDATED [POST] [/authn/token] Added api_otp grant type (get an OTP via API)
/register

UPDATED Modified endpoint:

  • Added the hid_sso_session_validity parameter for SSO configuration in the IdP workflow

  • Minor updates to other parameters

Version 1.1.1

Release date: 31 March 2023

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
General Fixed a minor issue in the IdP workflow configuration

Version 1.1.0

Release date: 13 January 2023

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/code NEW Endpoint to provide session transfer/authorization codes for FIDO
/consent NEW Endpoint to manage user consent for FIDO
/enroll NEW Endpoint to add a FIDO enrollment process to the IdP authentication workflow
/flow NEW Endpoint to return authentication types for the first factor authentication in the FIDO workflow
/theme NEW Endpoint to get the definition of the IdP design in the IdP authentication workflow

Version 1.0.4

Release date: 15 December 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
General Updated descriptions and examples

Version 1.0.3

Release date: 14 October 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/token UPDATED Modified endpoint:

  • Added ciba_delete (delete pending push transaction) grant type

  • [POST] [/authn/token] - added 204 response

  • Reworked descriptions
/login UPDATED [GET] [/authn/login] - fixed issues with query parameters

Version 1.0.2

Release date: 25 April 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/register UPDATED Replaced "configuration_id" by"workflow_id"
/token UPDATED Changed LEVEL_OF_ASSURANCE "type" from number to string
General Modified YAML title

Version 1.0.1

Release date: 14 January 2022

Compatibility:

  • HID Authentication Service

Download YAML

Updates in this revision:

Endpoint Details
/par UPDATED Clarified the endpoint description

Version 1.0

Release date: 03 January 2022

Compatibility:

  • HID Authentication Service

Download YAML