Initiate IDP Login

Initiates a login flow by redirecting the user to the enterprise Identity Provider (IDP) configured for the business.

The protocol (SAML 2.0 or OIDC) is determined automatically based on the BusinessMapping record associated with the client parameter.

Flow:

Client calls GET /api2/idp/login with client and redirect_uri in the request body.
GIS looks up the BusinessMapping to determine the IDP protocol.
GIS returns a 302 Found redirect to the IDP's login page.
After authentication, the IDP calls the appropriate GIS callback endpoint (SAML or OIDC).
GIS redirects to the original redirect_uri with a one-time code parameter.

Prerequisites:

The client must reference an OAuth application with the Advance Auth scope.
IDP authentication must be enabled for the business.
A valid BusinessMapping record must exist linking the client to an IDP configuration.

Headers

X-Correlation-Id
Type: string

Optional caller-provided correlation ID; echoed in responses when present.

Body·

required

application/json

Request body containing the client identifier and redirect URI.

client
Type: string
required

OAuth client ID provided by the business and configured with the Advance Auth scope. Required to identify the client application for authentication.
redirect_uri
Type: string Format: uri
required

URI to redirect to after successful IDP authentication. Must match one of the configured redirect URIs for the OAuth application.

Responses

get/api2/idp/login

curl https://SERVER_NAME_GOES_HERE/api2/idp/login \
  --header 'Content-Type: application/json' \
  --data '{
  "client": "",
  "redirect_uri": ""
}'

No Body

Redirect to the enterprise Identity Provider login page.