Skip to main content
Skip table of contents

Getting SSO services

Request

To get the available SSO services, send a GET request to:

CODE
https://<host>:<port>/ags/servicediscovery

Headers

  • x-correlation-id – identifier for logging, to correlate messages across a call flow.
  • nv-tenant-id – the tenant ID.
  • token – request authentication token.

Mandatory arguments

None

Other arguments

None

Response

A successful request returns an HTTP 200 status.

If no services can be found, the request returns an HTTP 404 status.

Example

A successful request returns a response that looks like this:

CODE
{
  "availableServices": [
    {
      "authServiceName": "Customer Auth Service",
      "displayAttributes": {
        "logo": "http://customer.com/auth.jpg",
        "name": "Customer Authentication"
      },
      "endpoints": [
        {
          "name": "SIGNON",
          "path": "/signOn",
          "parameterProperties": [
            {
              "name": "Username",
              "mandatory": false,
              "isPassword": false
            }
          ]
        }
      ]
    }
  ]
}

See also

For full details of this API, see the Authentication Gateway Service (AGS) API documentation.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.