API Reference

The HID Authentication Service is a multi-tenanted Software as a Service offering, for solving Identity and Access Management (IAM) problems. Integrating applications can use the Authentication Service for user authentication and for managing the user identity lifecycle and identity information.
The Authentication Service supports open web standards for authentication and identity management, including OAuth 2.0, OpenID Connect (OIDC) and the System for Cross-domain Identity Management (SCIM)
Common applications of the Authentication Service are:

  • Multi Factor Authentication (MFA)
  • Workforce Identity and Access Management (IAM)
  • Customer Identity and Access Management (CIAM)
  • Identity federation

The OpenID Connect API is used by client applications to verify the identity of users i.e. perform user authentication. The Authentication Service supports a range of authentication mechanisms from memorized secrets to multi-factor authentication. The choice of authenticator is dependent upon business risk and user convenience.

The SCIM API is used to manage user identities and identity data such as user profiles, authenticators and credentials. The Authentication Service implements the core SCIM 2.0 schema for managing resources such as users and groups. There are schema extensions to manage resources such as authenticators, credentials and devices.

This API Reference describes the RESTful API endpoints that helps developers to understand:

  • Resource endpoints
  • CRUD (HTTPS Methods) operation on resources
  • Request and Response payload
  • Content-type application/json; charset=UTF-8 and application/x-www-form-urlencoded
  • Error Codes