Documentation for Orion authentication API

July 19, 2024 ยท View on GitHub

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

ClassMethodHTTP requestDescription
DefaultApianonymousAuthPOST /anonymous-authAuthenticate as an anonymous user, either using an existing user identifier or creating a new one.
DefaultApichangeAccountPOST /change-accountChange the blockchain (Joystream) account associated with the Gateway account. Delete the old account's encryption artifacts and optionally set new ones.
DefaultApiconfirmEmailPOST /confirm-emailConfirm account's e-mail address provided during registration.
DefaultApicreateAccountPOST /accountCreate a new Gateway account. Requires anonymousAuth to be performed first.
DefaultApigetArtifactsGET /artifactsGet wallet seed encryption artifacts.
DefaultApigetSessionArtifactsGET /session-artifactsGet wallet seed encryption artifacts for the current session.
DefaultApiloginPOST /loginLogin to user's account by providing a message signed by the associated blockchain account.
DefaultApilogoutPOST /logoutTerminate the current session.
DefaultApipostSessionArtifactsPOST /session-artifactsSave wallet seed encryption artifacts for the current session on the server.
DefaultApiregisterUserInteractionPOST /register-user-interactionRegister a user interaction with Atlas part.
DefaultApirequestEmailConfirmationTokenPOST /request-email-confirmation-tokenRequest a token to be sent to account's e-mail address, which will allow confirming the ownership of the e-mail by the user.

Documentation for Models

Documentation for Authorization

bearerAuth

  • Type: HTTP basic authentication

cookieAuth

  • Type: API key
  • API key parameter name: session_id
  • Location: