REST API clients authentication

Last Updated : Jun 02, 2025 |
Prolog information
Metadata
Keywords:
REST API clients must authenticate with Presence Services to use the services provided by Presence Services.
Presence Services supports the following authentication types for REST API clients:
Authentication type
Authentication mechanism
Authentication strategy
Source of user credentials used to authenticate the client
Avaya
Digest
Use the Avaya Aura® credentials that are configured in System Manager.
The Presence or IM handle and communication profile password that is configured in the user profile in System Manager.
For more information, see Enabling Avaya Digest authentication to authenticate REST API clients.
Enterprise
Basic
Use the credentials that are configured in an Enterprise Directory service.
The Enterprise Directory server user element that is selected in the Presence Services configuration, and the password of the Enterprise Directory user.
For more information, see Enabling Enterprise Basic authentication to authenticate REST API clients.
Enterprise
IWA (Kerberos)
Use Single Sign On integrated Microsoft Windows credentials.
The user name and password of Microsoft Windows.
For more information, see Enterprise IWA over Kerberos authentication to authenticate REST API clients.
Enterprise
OAuth2 (JWT)
Use the JWT Bearer token provided by the client.
User authenticates with an authentication server like Avaya Aura® Device Services, AAS, and presents the issued JWT to Presence Services.
For more information, see Enabling Enterprise OAuth2/JWT authentication.
In addition to the specific configuration of Presence Services cluster service attributes for each authentication type, you must configure additional elements for Presence Services single-node and multinode cluster types.
For Presence Services single-node clusters, do the following:
Task
Comments
Configure the Service FQDN
Configure the Service FQDN in DNS, which for a single-node cluster is the Avaya Breeze® platform Security Module FQDN.
The DNS entry resolves to the Avaya Breeze® platform Security Module IP address.
For Presence Services multinode clusters, do the following:
Task
Comments
Configure the cluster IP address
For more information, see Configuring the cluster IP address.
Enable load balancer
For more information, see Enabling load balancer for Presence Services cluster.
Configure the Service FQDN
Configure the Service FQDN in the DNS. The DNS resolves the Service FQDN to the cluster IP address.
Note:
  • REST API clients use Service FQDN to connect to Presence Services.
  • Add the Service FQDN that you configured in the preceding procedures to the SAN field of the HTTP Security Identity certificate of all Presence Services cluster nodes. Add the Service FQDN to the SAN field if it is not already added to the CN field.