Documentation Powered by ReDoc

Identity Services (1.2.0)

Download OpenAPI specification:Download

Authentication

identityCookie

The name of the cookie depends on the servers configuration.

Security Scheme Type API Key
Cookie parameter name: ctIDENTITY

bearerToken

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT or ESRI"

Login

This endpoint is used to log in. In order to log in, the user is redirected to the login provider. If the login has been successful, the user is redirected to the URL given by the parameter returnURL.

query Parameters
returnURL
required
string <uri>
Example: returnURL=http://localhost/foo

URL to be redirected to after successfully logged in

Responses

Response samples

Content type
application/json;charset=utf-8
application/json;charset=utf-8
text/html;charset=iso-8859-1
{
  • "error": "MISSING_PARAMETER",
  • "errorMessage": "Missing parameter value for 'returnURL'"
}

Logout

This endpoint is used to log out. If the parameter returnURL is present and the logout has been successful, the user is redirected to the returnURL. If the parameter returnURL is missing, the result of the logout is returned as JSON.

Authorizations:
identityCookie
query Parameters
returnURL
string <uri>
Example: returnURL=http://localhost/foo

URL to be redirected to after successfully logged out

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "success": true
}

Back Channel Logout

Support for back channel logout triggered by identity provider, see OpenID Connect Back Channel Logout

Request Body schema: application/x-www-form-urlencoded
logout_token
required
string

Logout token of identity provider.

property name*
any

Responses

Response samples

Content type
application/json;charset=utf-8
{
  • "success": true
}

Get user information

Returns information about the user like name, roles, groups, and additional attributes.

Authorizations:
identityCookiebearerToken

Responses

Response samples

Content type
application/json;charset=utf-8
Example
Not authenticated user
Not authenticated user
Authenticated user
{
  • "authenticated": false
}

Retrieve list of token targets

Retrieve a list of urls for which a token needs to be requested. This should help clients to reduce trying to fetch tokens for unsupported targets.

Note: if the response status code is 200, a non-error response will be returned in the response body, unless the check query parameter is used.

Authorizations:
identityCookiebearerToken
query Parameters
boolean or string

If true, unauthorized requests will not trigger an http 401 response. 200 will be returned instead.

Responses

Response samples

Content type
application/json;charset=utf-8
{}

Retrieve a token

Retrieve a token for communication with another target

Authorizations:
identityCookiebearerToken
Request Body schema: application/x-www-form-urlencoded
target
required
string <uri>

URL for which the token is requested

Responses

Response samples

Content type
application/json;charset=utf-8
Example
Target is trusted and token available
Target is trusted and token available
Target is not part of the trusted targets
Failed to retrieve token for trusted target
{}

Returns meta data about the identity service

Returns meta data about the identity service. The meta data contains the name and url of the connected identity providers.

Responses

Response samples

Content type
application/json;charset=utf-8
{}