Skip to content

Authentication Service

The Authentication Service API allows you to manage the settings of the authentication service in your Access Gateway cluster. Authentication service settings at the cluster level apply to all applications and IdPs on the Access Gateway instance.

Note: This API is available in a Limited Early Access program and may be updated or changed based on feedback. Be aware that the API may change.

Retrieve the authentication service setting

Request

Early Access

Retrieves the current authentication service setting for Access Gateway

curl -i -X GET \
  https://oag.domain.tld/api/v2/settings/authentication-service

Responses

Success

Bodyapplication/json
certificateIdstring, (uuid)

The ID of the certificate to use for the authentication service

databaseobject

The database configuration for the authentication service

publicDomainstring

The external domain of the authentication service where end users are authenticated. The domain must be registered with a domain registrar.

serverNodesArray of strings

A list of hostnames of nodes in the Access Gateway cluster where the authentication service runs

Response
{ "serverNodes": [ "worker-node1.test-oag.com" ], "database": { "type": "mysql", "host": "db.domain.tld", "port": 3306, "name": "oagofflinemode" }, "publicDomain": "offline-idp-service.domain.tld", "certificateId": "15cc2bc6-b280-4d94-a0bf-c91751b40d9c" }