Accounts

A service that provides features for the management of accounts

Experimental feature: this API is likely to change.

Get the user authentication data

Retrieves and returns the account information for the authenticated user.

A user ID or email must be provided as a query parameter.

GEThttps://your-organization-id.m2worlds.io/api/accounts/auth/user/

Authorization

BearerAuth

Query parameters

Header parameters

Response

200

The response to querying a user's account information. We return an array which will be empty if no user is found, and may contain multiple entries if the query parameter is an email.

Body

application/json

uid*string

emailVerified*boolean

emailstring

displayNamestring

photoURLstring

providerDataarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/accounts/auth/user/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "uid": "text",
    "emailVerified": false,
    "email": "text",
    "displayName": "text",
    "photoURL": "text",
    "providerData": [
      {
        "providerId": "text",
        "uid": "text",
        "email": "text",
        "displayName": "text",
        "photoURL": "text",
        "phoneNumber": "text"
      }
    ]
  }
]

Create a new user account

Creates a new user account in the authentication system. A custom user ID can be provided.

POSThttps://your-organization-id.m2worlds.io/api/accounts/auth/user/

Authorization

BearerAuth

Header parameters

Body

application/json

uidstring

The user ID to use for this new user. If not specified, one will be created.

displayNamestring

emailstring

emailVerifiedboolean

photoURLstring

Response

200

The information of the created user

Body

application/json

uid*string

emailVerified*boolean

emailstring

displayNamestring

photoURLstring

providerDataarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/accounts/auth/user/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "uid": "text",
  "emailVerified": false,
  "email": "text",
  "displayName": "text",
  "photoURL": "text",
  "providerData": [
    {
      "providerId": "text",
      "uid": "text",
      "email": "text",
      "displayName": "text",
      "photoURL": "text",
      "phoneNumber": "text"
    }
  ]
}

Service health check

GEThttps://your-organization-id.m2worlds.io/api/accounts/healthz/

Response

200

Provides information about the service status.

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/accounts/healthz/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Generate a custom token for a user

Generate a custom token for a user that can be used to authenticate.

POSThttps://your-organization-id.m2worlds.io/api/accounts/token/generate/

Authorization

BearerAuth

Header parameters

Body

application/json

userId*string

The user ID to generate a custom token for

Response

200

The response to generating a custom token

Body

application/json

token*string

The generated custom token

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/accounts/token/generate/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userId": "text"
    }),
});
const data = await response.json();

Response

200

{
  "token": "text"
}

Refresh token

Returns a new ID token and refresh token for the given user.

POSThttps://your-organization-id.m2worlds.io/api/accounts/token/refresh/

Authorization

BearerAuth

Header parameters

Body

application/json

refreshToken*string

Response

200

The response to refreshing a token

Body

application/json

idToken*string

refreshToken*string

expiresIn*string

userId*string

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/accounts/token/refresh/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "refreshToken": "text"
    }),
});
const data = await response.json();

Response

200

{
  "idToken": "text",
  "refreshToken": "text",
  "expiresIn": "text",
  "userId": "text"
}

Sign in with custom token

The endpoint signs in or signs up a user by exchanging a custom Auth token for an ID token and a refresh token.

POSThttps://your-organization-id.m2worlds.io/api/accounts/token/signin/

Authorization

BearerAuth

Header parameters

Body

application/json

token*string

The custom token to sign in with

Response

200

The response to generating a custom token

Body

application/json

idToken*string

refreshToken*string

expiresIn*string

isNewUser*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/accounts/token/signin/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "token": "text"
    }),
});
const data = await response.json();

Response

200

{
  "idToken": "text",
  "refreshToken": "text",
  "expiresIn": "text",
  "isNewUser": false
}

Fetch a user's account

Retrieves and returns the account information for the specified user. An email address and wallet address will only be returned if the user has verified them.

This API can be called by the user themselves, the Unreal server, or any user with read permissions on the organization's user profiles.

GEThttps://your-organization-id.m2worlds.io/api/accounts/users/{userId}/

Authorization

BearerAuth

Path parameters

userId*string

The user ID to fetch the account for

Header parameters

Response

200

The response to querying a user's account information

Body

application/json

evmLinkedWalletstring

The verified EVM wallet linked by this user

emailstring

The verified email address associated with this user

isGuest*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/accounts/users/{userId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

{
  "evmLinkedWallet": "text",
  "email": "text",
  "isGuest": false
}