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.

get

/auth/user/

Authorizations

Query parameters

userIdstring

The user ID to fetch the auth account details for

emailstring

The email to fetch the auth account details for

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/accounts/auth/user/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

200

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

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.

Create a new user account

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

post

/auth/user/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

uidstring

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

displayNamestring

emailstring

emailVerifiedboolean

photoURLstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/accounts/auth/user/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json'

200

200

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

The information of the created user

Service health check

get

/healthz/

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/accounts/healthz/'

200

200

text

Provides information about the service status.

Generate a custom token for a user

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

post

/token/generate/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

userIdstringrequired

The user ID to generate a custom token for

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/accounts/token/generate/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"userId":"text"}'

200

200

{
  "token": "text"
}

The response to generating a custom token

Refresh token

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

post

/token/refresh/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

refreshTokenstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/accounts/token/refresh/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"refreshToken":"text"}'

200

200

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

The response to refreshing a token

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.

post

/token/signin/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

tokenstringrequired

The custom token to sign in with

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/accounts/token/signin/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"token":"text"}'

200

200

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

The response to generating a custom token

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.

get

/users/{userId}//

Authorizations

Path parameters

userIdstringrequired

The user ID to fetch the account for

Header parameters

x-m2-organization-idstring

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/accounts/users/{userId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

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

The response to querying a user's account information

Remove a user's account

Removes the account information for the specified user.

This API can be called by any user with all permissions to an organization or a user who has the highest level of permissions if no organization is provided.

delete

/users/{userId}//

Authorizations

Path parameters

userIdstringrequired

The ID of a user

Header parameters

x-m2-organization-idstring

The ID of an organization

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/accounts/users/{userId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

4XX

204

{
  "userId": "text"
}

The ID of the user to be deleted

Fetch the requesting user's account

Retrieves and returns the entire account information for the user making the request.

get

/users/current/

Authorizations

Header parameters

x-m2-organization-idstring

The ID of an organization

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/accounts/users/current/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

{
  "name": "text",
  "pictureUrl": "text",
  "email": "text",
  "emailVerified": true,
  "emailDomain": "text",
  "isGuest": true,
  "evmLinkedWallet": {
    "nonce": "text",
    "address": "text",
    "verified": true
  },
  "evmWallet": {
    "nonce": "text",
    "address": "text",
    "verified": true
  },
  "tenantId": "text",
  "organizationId": "text"
}

The response to querying a user's account information.