GET /api/login/ssoLoginInstructions

Returns applicable instructions for logging in the user, depending on the login option the user has selected.

If the login domain needs credentials, the response indicates this and indicates which credentials are needed. If the login domain requires a redirect to the authentication provider, the response indicates NeedRedirect and indicates the redirect URL for the applicable login provider.

Authorization Roles/Permissions: No permissions required.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/login/ssoLoginInstructions?domain={domain}

Back to top

Sample Request

The example below shows a login request when the user has selected LDAP as the login option. The second example shows request headers when the user has selected Google.

Request URL

https://{hostname}/api/login/ssoLoginInstructions?domain=LdapAutomation

Sample request headers #1: login using LDAP

GET /api/login/ssoLoginInstructions?domain=LdapAutomation HTTP/1.1
Host: {hostname}
Accept: */*

Sample request headers #2: login using Google

GET /api/login/ssoLoginInstructions?domain=GoogleAutomation HTTP/1.1
Host: {hostname}
Accept: */*

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
domain Query string Required The login domain applicable for the login option selected by the user. Example: LdapAutomation.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the login response applicable for the login option specified by the user.

Back to top

Sample Response

The sample response below shows the response when the user chose to log in using LDAP.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/json

Sample response body #1: login using LDAP

{
  "identityAttributesNeeded" : [ "username" ],
  "secretAttributesNeeded" : [ "password" ],
  "instructionType" : "NeedCredentials"
}

Sample response body #2: login using Google

Line breaks have been added for display purposes.

{
  "instructionType" : "NeedRedirect",
  "redirectUrl" : "https://www.google.com/accounts/o8/ud?openid.ns=http%3A%2F%2Fspecs.openid.net%2Fauth%2F2.0
&openid.claimed_id=http%3A%2F%2Fspecs.openid.net
%2Fauth%2F2.0%2Fidentifier_select&openid.identity=http%3A%2F%2Fspecs.openid.net%2Fauth%2F2.0%2Fidentifier_select
&openid.return_to=http%3A%2F%2Facmepaymentscorp%2Fapi%2Flogin%2FssoLogin%3Fdomain%3DGoogleAutomation%26ssoRetryCount%3D0
&openid.realm=http%3A%2F%2Facmepaymentscorp&openid.assoc_handle=1.AMlYA9WaF_97DzuvUZ7vLyEKneAxUoVm7YhaTvqJhONKlh6c96TWJMcar0MaDxiW4BvIFuf_ijaAuw
&openid.mode=checkid_setup&openid.ns.ext1=http%3A%2F%2Fopenid.net%2Fsrv%2Fax%2F1.0&openid.ext1.type.email=http%3A%2F%2Faxschema.org%2Fcontact%2Femail
&openid.ext1.type.lastname=http%3A%2F%2Faxschema.org%2FnamePerson%2Flast&openid.ext1.type.firstname=http%3A%2F%2Faxschema.org%2FnamePerson%2Ffirst
&openid.ext1.type.fullname=http%3A%2F%2Faxschema.org%2FnamePerson&openid.ext1.required=firstname%2Clastname%2Cemail%2Cfullname&openid.ext1.mode=
fetch_request">https://www.google.com/accounts/o8/ud?openid.ns=http%3A%2F%2Fspecs.openid.net%2Fauth%2F2.0
&openid.claimed_id=http%3A%2F%2Fspecs.openid.net
%2Fauth%2F2.0%2Fidentifier_select&openid.identity=http%3A%2F%2Fspecs.openid.net%2Fauth%2F2.0%2Fidentifier_select
&openid.return_to=http%3A%2F%2Facmepaymentscorp%2Fapi%2Flogin%2FssoLogin%3Fdomain%3DGoogleAutomation%26ssoRetryCount%3D0
&openid.realm=http%3A%2F%2Facmepaymentscorp&openid.assoc_handle=1.AMlYA9WaF_97DzuvUZ7vLyEKneAxUoVm7YhaTvqJhONKlh6c96TWJMcar0MaDxiW4BvIFuf_ijaAuw
&openid.mode=checkid_setup&openid.ns.ext1=http%3A%2F%2Fopenid.net%2Fsrv%2Fax%2F1.0&openid.ext1.type.email=http%3A%2F%2Faxschema.org%2Fcontact%2Femail
&openid.ext1.type.lastname=http%3A%2F%2Faxschema.org%2FnamePerson%2Flast&openid.ext1.type.firstname=http%3A%2F%2Faxschema.org%2FnamePerson%2Ffirst
&openid.ext1.type.fullname=http%3A%2F%2Faxschema.org%2FnamePerson&openid.ext1.required=firstname%2Clastname%2Cemail%2Cfullname&openid.ext1.mode=fetch_request
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
LoginData LoginData Contains data associated with a user's login.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics