User Profile

Manages user profiles

Fetch a user's profile

Returns the profile of the user making the request.

GEThttps://your-organization-id.m2worlds.io/api/profile/

Authorization

BearerAuth

Header parameters

Response

200

The profile of a given user in an organization.

Body

application/json

usernamestring

profilePictureUrlstring

avatarobject

evmLinkedWalletAddressstring

The linked EVM wallet address for the user, if verified.

Request

JavaScriptCurlPython

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

Response

200

{
  "username": "text",
  "profilePictureUrl": "text",
  "avatar": {
    "url": "text",
    "datasourceId": "text",
    "objectDefinitionId": "text"
  },
  "evmLinkedWalletAddress": "text"
}

Upserts a user's profile

Updates the profile of the user making the request. If the user does not have a profile, one will be created. The profile picture and avatar of a user can be unset using this endpoint.

The endpoint accepts a JSON object as body, which allows upserting various fields of the user's profile. An image from the user's collection can be set a profile picture by sending its datasource and object definition IDs in the body.

The endpoint also accepts a file (image) in binary format as body, which will be uploaded and saved as the user's profile picture. The Content-Type header has to be set to 'multipart/form-data' when sending a file.

PUThttps://your-organization-id.m2worlds.io/api/profile/

Authorization

BearerAuth

Header parameters

Body

application/json

usernamestring

The username of a user. It might have restricted length and characters, based on the organization's settings.

profilePictureany

This field is populated by a middleware when a file is sent as body. It should not be set by the client.

profilePictureObjectDefinitionIdany of

The datasource ID and object definition ID of the profile picture object. If null, the profile picture will be unset.

objectnull

avatarObjectDefinitionIdany of

The datasource ID and object definition ID of the avatar object. If null, the avatar will be unset.

objectnull

Response

200

The user's profile after upserting it.

Body

application/json

usernamestring

profilePictureUrlstring

avatarObjectDefinitionIdobject

Request

JavaScriptCurlPython

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

Response

200

{
  "username": "text",
  "profilePictureUrl": "text",
  "avatarObjectDefinitionId": {
    "datasourceId": "text",
    "objectDefinitionId": "text"
  }
}

Service health check

GEThttps://your-organization-id.m2worlds.io/api/profile/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/profile/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Ban and replace usernames

This endpoint adds the provided list of usernames to the (possibly already existing) denylist. If a username is already in use, it is replaced with the provided replacement username. The request must contain a list of pairs of usernames: one to be added to the denylist, and the other to replace it if it is already in use. If a username is already in the denylist, it is skipped.

This operation can be totally or partially successful. If some usernames could not be added to the denylist, the response will contain a list of those usernames.

None of the usernames in the request need to obey the restrictions regarding length and allowed characters.

Important note: denylists rely on unique usernames being enforced at the organization level.

POSThttps://your-organization-id.m2worlds.io/api/profile/username/deny/

Authorization

BearerAuth

Header parameters

Body

application/json

A record of usernames to add to the denylist, specifying replacements if they are already in use

Other propertiesUsername (string)

The username of a user. It might have restricted length and characters, based on the organization's settings.

Response

204207

Default Response

Body

application/json

any

Request

JavaScriptCurlPython

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

Response

207

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0,
  "usernamesWithErrors": [
    "text"
  ]
}

Delete usernames from the denylist

This endpoint removes the provided list of usernames from the denylist. If a username is in use and therefore cannot be removed from the denylist, it is skipped and returned as part of the response.

Important note: denylists rely on unique usernames being enforced at the organization level.

DELETEhttps://your-organization-id.m2worlds.io/api/profile/username/deny/

Authorization

BearerAuth

Header parameters

Body

application/json

An array of usernames to remove from the denylist

itemsstring

Response

200207

The response of deleting usernames from the denylist

Body

application/json

usernamesDeleted*array of string

usernamesInUse*array of string

Request

JavaScriptCurlPython

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

Response

200207

{
  "usernamesDeleted": [
    "text"
  ],
  "usernamesInUse": [
    "text"
  ]
}

Overwrite the list of denylisted usernames

This endpoint replaces the current denylist with the provided list of usernames. If the operation cannot be completed due to some usernames already being in use, the response will contain a list of those usernames. In this case, the denylist will not be modified, and an admin can first overwrite the usernames being used (see the POST api/profile/deny endpoint), and then try again.

None of the usernames in the request need to obey the restrictions regarding length and allowed characters.

Important note: denylists rely on unique usernames being enforced at the organization level.

PUThttps://your-organization-id.m2worlds.io/api/profile/username/denylist/

Authorization

BearerAuth

Header parameters

Body

application/json

An array of usernames to add to the denylist

itemsstring

Response

204409

Default Response

Body

application/json

any

Request

JavaScriptCurlPython

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

Response

409

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0,
  "usedUsernames": [
    "text"
  ]
}