Login Flows

When the client is authenticating it must go through a series of steps called login flows. The Login Flows API returns the entry point URIs for the available login flows. REST API clients should choose the rest entry point.

Get Available Login Flows

A GET request is used to retrieve the available login flows.

Request parameters

None

Request fields

None

Response fields

Path Type Description

data.flows[0].name

String

The name of the flow.

data.flows[0].entryPointUri

String

The URI to call to initiate the flow.

status

String

HTTP Status Code.

Example request

GET /api/v3/login/flows HTTP/1.1
Host: localhost:8080

Example response

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

{"status":"OK","data":{"flows":[{"entryPointUri":"/login/ui/initial","name":"ui"},{"entryPointUri":"/api/v3/login/rest/tenant/methods","name":"rest"}]}}