Accounts
The Accounts service allows you to manage user accounts registered within your organization, including creation, updates, and access control.
Retrieves and returns the account information for the authenticated user.
A user ID or email must be provided as a query parameter.
The user ID to fetch the auth account details for
The email to fetch the auth account details for
The ID of an organization
GET /api/accounts/auth/user/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
Accept: */*
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.
[
{
"uid": "text",
"emailVerified": true,
"email": "text",
"displayName": "text",
"photoURL": "text",
"providerData": [
{
"providerId": "text",
"uid": "text",
"email": "text",
"displayName": "text",
"photoURL": "text",
"phoneNumber": "text"
}
]
}
]Creates a new user account in the authentication system. A custom user ID can be provided.
The ID of an organization
The request body for creating a new auth user
The user ID to use for this new user. If not specified, one will be created.
Optional for user creation, but required for streaming access
POST /api/accounts/auth/user/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 89
{
"uid": "text",
"displayName": "text",
"email": "text",
"emailVerified": true,
"photoURL": "text"
}The information of the created user
{
"uid": "text",
"emailVerified": true,
"email": "text",
"displayName": "text",
"photoURL": "text",
"providerData": [
{
"providerId": "text",
"uid": "text",
"email": "text",
"displayName": "text",
"photoURL": "text",
"phoneNumber": "text"
}
]
}Generate a custom token for a user that can be used to authenticate.
Requires "*" permission on the organization and its children, and the "allowUserTokenManagement" flag to be enabled on the organization.
The ID of an organization
The request body for generating a custom token
The user ID to generate a custom token for
POST /api/accounts/token/generate/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"userId": "text"
}The response to generating a custom token
{
"token": "text"
}Returns a new ID token and refresh token for the given user.
Requires "*" permission on the organization and its children, and the "allowUserTokenManagement" flag to be enabled on the organization.
The ID of an organization
The request body for refreshing a token
POST /api/accounts/token/refresh/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"refreshToken": "text"
}The response to refreshing a token
{
"idToken": "text",
"refreshToken": "text",
"expiresIn": "text",
"userId": "text"
}The endpoint signs in or signs up a user by exchanging a custom Auth token for an ID token and a refresh token.
Requires "*" permission on the organization and its children, and the "allowUserTokenManagement" flag to be enabled on the organization.
The ID of an organization
The request body for signing in with a custom token
The custom token to sign in with
POST /api/accounts/token/signin/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"token": "text"
}The response to generating a custom token
{
"idToken": "text",
"refreshToken": "text",
"expiresIn": "text",
"isNewUser": true
}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.
The user ID to fetch the account for
The ID of an organization
GET /api/accounts/users/{userId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
Accept: */*
The response to querying a user's account information
{
"evmLinkedWallet": "text",
"email": "text",
"isGuest": true
}Updates the account information for the authenticated user.
The ID of an organization
The parameters required to patch a user's account information. At least one of email or emailVerified must be provided.
The information of the patched user
PATCH /api/accounts/users/{userId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"email": "text",
"emailVerified": true
}The information of the patched user
{
"name": "text",
"pictureUrl": "text",
"email": "text",
"emailVerified": true,
"evmLinkedWallet": {
"nonce": "text",
"address": "text",
"verified": true
},
"evmWallet": {
"nonce": "text",
"address": "text",
"verified": true
},
"emailDomain": "text",
"isGuest": true,
"tenantId": "text",
"organizationId": "text"
}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.
The ID of a user
The ID of an organization
DELETE /api/accounts/users/{userId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
Accept: */*
{
"userId": "text"
}Retrieves and returns the entire account information for the user making the request.
The ID of an organization
The response to querying a user's account information.
GET /api/accounts/users/current/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
Accept: */*
{
"name": "text",
"pictureUrl": "text",
"email": "text",
"emailVerified": true,
"evmLinkedWallet": {
"nonce": "text",
"address": "text",
"verified": true
},
"evmWallet": {
"nonce": "text",
"address": "text",
"verified": true
},
"emailDomain": "text",
"isGuest": true,
"tenantId": "text",
"organizationId": "text"
}Last updated
Was this helpful?