auth

Fetch auth session details front-door

Gets auth session details by the session id.

get/auth/session/{id}

Request

Base URL: http://localhost:8080
URL: http://localhost:8080/auth/session/{id}
Auth: none required

Path parameters

idstring required

The session id (state)

Example:Qui doloribus est reprehenderit qui suscipit.

Query parameters

mode'embedded' | 'standalone'

The mode of the session

Example:standalone

Response

OK response.

arrangement_idstring

Existing CDR arrangement ID to amend/update

arrangement_id_expiration_datestring

Existing CDR arrangement ID expiration date

auth_urlstring required

The computed auth URL.

cancel_uristring required

Your url to cancel an auth flow

client_idstring required

The client that the end user belongs to

created_atstring required

Time at which session is created

end_user_idstring required

The end_user that will be consenting with an external provider

expires_atstring required

Time at which session expires

institution_idstring

The institution id selected for the auth session

is_terminalboolean

The terminal state

missing_abnboolean

Indicates whether the end user is missing ABN information

missing_emailboolean

Indicates whether the end user is missing email information

redirect_uristring required

Where the end user will be redirected to on success

session_idstring required

Session Id

Example response

{
  "arrangement_id": "94549a73-a554-4b76-b824-d96898829751",
  "arrangement_id_expiration_date": "2022-02-18T01:57:59Z",
  "auth_url": "auth.fiskil.com?session_id=ea564d-56012s4-6ds4564",
  "cancel_uri": "https://acme.com/cancel",
  "client_id": "5qcql2s0bn9qfh1m5qd1sl4gth",
  "created_at": "2022-02-18T01:57:59Z",
  "end_user_id": "eu_2yRHN2ag2y4p8kCtm5DOeccZEXB",
  "events": [
    {
      "event_time": "2022-02-18T01:57:59Z",
      "meta": {
        "Est maiores rerum nostrum quaerat modi.": "Qui laborum voluptatem."
      },
      "type": "AUTH_SESSION_CREATED"
    },
    {
      "event_time": "2022-02-18T01:57:59Z",
      "meta": {
        "Est maiores rerum nostrum quaerat modi.": "Qui laborum voluptatem."
      },
      "type": "AUTH_SESSION_CREATED"
    },
    {
      "event_time": "2022-02-18T01:57:59Z",
      "meta": {
        "Est maiores rerum nostrum quaerat modi.": "Qui laborum voluptatem."
      },
      "type": "AUTH_SESSION_CREATED"
    },
    {
      "event_time": "2022-02-18T01:57:59Z",
      "meta": {
        "Est maiores rerum nostrum quaerat modi.": "Qui laborum voluptatem."
      },
      "type": "AUTH_SESSION_CREATED"
    }
  ],
  "expires_at": "2022-02-18T01:57:59Z",
  "institution_id": "10",
  "is_terminal": false,
  "missing_abn": true,
  "missing_email": true,
  "redirect_uri": "https://acme.com/success",
  "session_id": "ea564d-56012s4-6ds4564"
}

Changes

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