All URIs are relative to http://localhost/api/v1
| Method | HTTP request | Description |
|---|---|---|
| anonymousAuth | POST /anonymous-auth | |
| changeAccount | POST /change-account | |
| confirmEmail | POST /confirm-email | |
| createAccount | POST /account | |
| getArtifacts | GET /artifacts | |
| getSessionArtifacts | GET /session-artifacts | |
| login | POST /login | |
| logout | POST /logout | |
| postSessionArtifacts | POST /session-artifacts | |
| requestEmailConfirmationToken | POST /request-email-confirmation-token |
AnonymousUserAuthResponseData anonymousAuth(AnonymousUserAuthRequestData)
Authenticate as an anonymous user, either using an existing user identifier or creating a new one.
| Name | Type | Description | Notes |
|---|---|---|---|
| AnonymousUserAuthRequestData | AnonymousUserAuthRequestData | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
GenericOkResponseData changeAccount(ChangeAccountRequestData)
Change the blockchain (Joystream) account associated with the Gateway account. Delete the old account's encryption artifacts and optionally set new ones.
| Name | Type | Description | Notes |
|---|---|---|---|
| ChangeAccountRequestData | ChangeAccountRequestData | [optional] |
- Content-Type: application/json
- Accept: application/json
GenericOkResponseData confirmEmail(ConfirmEmailRequestData)
Confirm account's e-mail address provided during registration.
| Name | Type | Description | Notes |
|---|---|---|---|
| ConfirmEmailRequestData | ConfirmEmailRequestData | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
GenericOkResponseData createAccount(CreateAccountRequestData)
Create a new Gateway account. Requires anonymousAuth to be performed first.
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateAccountRequestData | CreateAccountRequestData | [optional] |
- Content-Type: application/json
- Accept: application/json
EncryptionArtifacts getArtifacts(id, email)
Get wallet seed encryption artifacts.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The lookup key derived from user's credentials. | [default to null] |
| String | The user's email address. | [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
EncryptionArtifacts getSessionArtifacts()
Get wallet seed encryption artifacts for the current session.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
LoginResponseData login(LoginRequestData)
Login to user's account by providing a message signed by the associated blockchain account.
| Name | Type | Description | Notes |
|---|---|---|---|
| LoginRequestData | LoginRequestData | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
GenericOkResponseData logout()
Terminate the current session.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
GenericOkResponseData postSessionArtifacts(SessionEncryptionArtifacts)
Save wallet seed encryption artifacts for the current session on the server.
| Name | Type | Description | Notes |
|---|---|---|---|
| SessionEncryptionArtifacts | SessionEncryptionArtifacts | [optional] |
- Content-Type: application/json
- Accept: application/json
GenericOkResponseData requestEmailConfirmationToken(RequestTokenRequestData)
Request a token to be sent to account's e-mail address, which will allow confirming the ownership of the e-mail by the user.
| Name | Type | Description | Notes |
|---|---|---|---|
| RequestTokenRequestData | RequestTokenRequestData | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json