v1

latestOpenAPI 3.0.3Apache 2.02026-07-1756158355.3 KB

frontend

Exchange Session Token

get/sessions/token-exchange

Query parameters

init_codestring required

The part of the code return when initializing the flow.

return_to_codestring required

The part of the code returned by the return_to URL.

Response

successfulNativeLogin

session_tokenstring

The Session Token

A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header:

Authorization: bearer ${session-token}

The session token is only issued for API flows, not for Browser flows!

Example response

{
  "session_token": "session_token",
  "session": {
    "tokenized": "tokenized",
    "expires_at": "2000-01-23T04:56:07.000+00:00",
    "devices": [
      {
        "location": "location",
        "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "ip_address": "ip_address",
        "user_agent": "user_agent"
      },
      {
        "location": "location",
        "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "ip_address": "ip_address",
        "user_agent": "user_agent"
      }
    ],
    "authentication_methods": [
      {
        "completed_at": "2000-01-23T04:56:07.000+00:00",
        "method": "password",
        "provider": "provider",
        "organization": "organization",
        "aal": "aal0"
      },
      {
        "completed_at": "2000-01-23T04:56:07.000+00:00",
        "method": "password",
        "provider": "provider",
        "organization": "organization",
        "aal": "aal0"
      }
    ],
    "authenticator_assurance_level": null,
    "identity": {
      "traits": "",
      "credentials": {
        "key": {
          "updated_at": "2000-01-23T04:56:07.000+00:00",
          "identifiers": [
            "identifiers",
            "identifiers"
          ],
          "created_at": "2000-01-23T04:56:07.000+00:00",
          "type": "password",
          "config": "{}",
          "version": 0
        }
      },
      "state_changed_at": "2000-01-23T04:56:07.000+00:00",
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "external_id": "external_id",
      "recovery_addresses": [
        {
          "updated_at": "2000-01-23T04:56:07.000+00:00",
          "created_at": "2000-01-23T04:56:07.000+00:00",
          "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "value": "value",
          "via": "via"
        },
        {
          "updated_at": "2000-01-23T04:56:07.000+00:00",
          "created_at": "2000-01-23T04:56:07.000+00:00",
          "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "value": "value",
          "via": "via"
        }
      ],
      "metadata_admin": "",
      "updated_at": "2000-01-23T04:56:07.000+00:00",
      "verifiable_addresses": [
        {
          "updated_at": "2014-01-01T23:28:56.782Z",
          "verified_at": "2000-01-23T04:56:07.000+00:00",
          "verified": true,
          "created_at": "2014-01-01T23:28:56.782Z",
          "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "value": "value",
          "status": "status",
          "via": "email"
        },
        {
          "updated_at": "2014-01-01T23:28:56.782Z",
          "verified_at": "2000-01-23T04:56:07.000+00:00",
          "verified": true,
          "created_at": "2014-01-01T23:28:56.782Z",
          "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "value": "value",
          "status": "status",
          "via": "email"
        }
      ],
      "organization_id": "organization_id",
      "schema_id": "schema_id",
      "schema_url": "schema_url",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "state": "active",
      "metadata_public": ""
    },
    "authenticated_at": "2000-01-23T04:56:07.000+00:00",
    "active": true,
    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "issued_at": "2000-01-23T04:56:07.000+00:00"
  },
  "continue_with": [
    {
      "action": "show_verification_ui",
      "flow": {
        "verifiable_address": "verifiable_address",
        "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "url": "url"
      }
    },
    {
      "action": "show_verification_ui",
      "flow": {
        "verifiable_address": "verifiable_address",
        "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "url": "url"
      }
    }
  ]
}