auth
public
v1
v2
v3

Create auth session front-door

Create an auth session before auth process.

post/auth/session

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/auth/session
  • Auth: HTTP bearer

Request body

arrangement_idstring

Existing CDR arrangement ID to amend/update

cancel_uristring

Where the end user will be redirected on cancellation or failure. Required for redirect flows.

end_user_idstring required

The end_user that will be consenting with an external provider

institution_idstring

The institution id selected for the auth session. The user will not be able to select another institution during the consent flow.

redirect_uristring

Where the end user will be redirected to on success. Required for redirect flow.

Example request

{
  "arrangement_id": "94549a73-a554-4b76-b824-d96898829751",
  "cancel_uri": "https://acme.com/cancel",
  "end_user_id": "eu_2yRHN2ag2y4p8kCtm5DOeccZEXB",
  "institution_id": "10",
  "redirect_uri": "https://acme.com/success"
}

Response

OK response.

auth_urlstring required

The computed auth URL.

expires_atinteger required

The computed auth URL expires at.

idstring required

The client id.

session_idstring required

Session Id

Example response

{
  "auth_url": "auth-session.com/redirect-url",
  "expires_at": 1213467,
  "id": "5qcql2s0bn9qfh1m5qd1sl4gth",
  "session_id": "ea564d-56012s4-6ds4564"
}

Changes

No recorded changes to this operation across all 1 revision of this API.