Signing out with SSO

Request

To sign out using SSO, send a POST request to:

https://<host>:<port>/ags/signOut

Headers

Authorization – the access token that was returned during initial sign-on
x-correlation-id – identifier for logging, to correlate messages across a call flow
x-auth-service-id – the ID of the authentication (SSO) service to be used for authentication (mandatory)
nv-tenant-id – the tenant ID

Mandatory arguments

Authorization – (in header) – see above
x-auth-service-id – (in header) – see above
parameters – an array of parameters. These are defined in the response to the GET /servicediscovery request.
Each member of the array is a key/value pair in the following form:
```
{
  "parameters": [
    {
       "name": "<name>",
       "value": "<value>"
    }
  ]
} 
```

Other arguments

None

Example

A POST request with this payload signs the client out:

{
  "parameters": [
    {
      "name": "username",
      "value": "dave"
    }
  ]
}

Note that the contents of the parameters block depend on the requirements of the SSO provider.

Response

A successful request returns an HTTP 200.

A bad request returns an HTTP 400 status.

A forbidden request returns an HTTP 403 status.

If the specified <entity> does not exist, the request returns an HTTP 404 status.

See also

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