profile

Manages user profiles

Returns a user profile in a given organization

GEThttp://admin.m2worlds.io/api/profile/

Authorization

BearerAuth

Header parameters

Response

4002XX

Default Response

Body

application/json

error*string

HTTP error message

codestring

Fastify error code

message*string

User error message

statusCode*number

HTTP status code

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/profile/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Upserts a user profile in a given organization

PUThttp://admin.m2worlds.io/api/profile/

Authorization

BearerAuth

Header parameters

Body

application/json

usernamestring

profilePictureany

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

2004XX

Default Response

Body

application/json

usernamestring

profilePictureUrlstring

avatarObjectDefinitionIdobject

Request

JavaScriptCurl

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

Response

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

Service health check

GEThttp://admin.m2worlds.io/api/profile/healthz

Response

200

Default Response

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/profile/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"