social groups

Manages social groups and their members

Experimental feature: this API is likely to change.

Service health check

GEThttp://admin.m2worlds.io/api/social-groups/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/social-groups/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

List all social groups for a project

GEThttp://admin.m2worlds.io/api/social-groups/

Authorization

BearerAuth

Query parameters

Response

200

Default Response

Body

application/json

name*string

The name of a social group

description*string

The description of a social group

pictureUrlstring

The picture to use for a social group

spaceUrl*string

The URL of the 3D Web Renderer server for a social group

inviteIdsarray of string

The Invite IDs for joining a social group

bannedUserIdsarray of string

The IDs of users banned from a social group

creatorUserNamestring

creatorUserPictureUrlstring

permissionVerb*any of

Actions allowed on a resource

enumenumenum

socialGroupId*string

The ID of a social group

Request

JavaScriptCurl

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

Response

[
  {
    "name": "text",
    "description": "text",
    "pictureUrl": "text",
    "spaceUrl": "text",
    "inviteIds": [
      "text"
    ],
    "bannedUserIds": [
      "text"
    ],
    "creatorUserName": "text",
    "creatorUserPictureUrl": "text",
    "permissionVerb": "*",
    "socialGroupId": "text"
  }
]

Create a new social group

POSThttp://admin.m2worlds.io/api/social-groups/

Authorization

BearerAuth

Body

application/json

name*string

The name of a social group

description*string

The description of a social group

projectId*string

The ID of a project

Response

200

Default Response

Body

application/json

socialGroupId*string

The ID of a social group

Request

JavaScriptCurl

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

Response

{
  "socialGroupId": "text"
}