Skip to main content
POST
Start a session

Authorizations

JSESSIONID
string
cookie
required

Body

application/json

Login request object

The data model that contains the possible values to be provided in a login request. authIdentifier and credential are mandatory fields.

authnIdentifier
string
required

Connect authentication identifier

Example:

"john@example.com"

credential
string
required

The password, PIN, or other login credential supplied by the user

Example:

"changeme"

guid
string
captchaResponse
string

Captcha response if captcha is enabled

Example:

"03AOLTBLSSzhhrLdqCb"

Response

OK

The API returns information about parameters that are required by the next process step (only if lastStep is false). Optionally information from the previous is returned in 'output'. For AuthenticationStepAction actions, it returns authenticated context information (userId, runtimeId, userAuthenticated). For AdminUser authentication actions the API also returns adminUser.

displayMessage
string

Optional display message

Example:

"Enter User Inputs"

parameters
object

User input parameters

processId
string

The process identifier that links multiple API calls together. If a process halts because it requires additional data, then it assigns a process ID that can be referenced in subsequent calls in order to continue and complete the entire process.

Example:

"640b4b3a-dbaf-4b73-abfb-979475aee0bb"

processName
string

The name of the process which is being executed. This value is intended to be consumed by User Interfaces which may not always be aware of the current process being executed, owing to factors such as a third-party redirect in the middle of the process destroying the UI's context.

Example:

"socialFederation.associateSocialMedia_v1.0"

stepName
string

The step name

Example:

"PasswordPrompt"

lastStep
boolean
output
object

Information returned from previous step.

runtimeId
integer<int64>

The unique ID of an entity.

Example:

1

userId
integer<int64>

The unique ID of an entity.

Example:

1

userAuthenticated
boolean

For AuthenticationStepAction only.