groupsync

Enables automated role management by groupsync

Service health check

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

Response

"text"

Get groupsync roles

GEThttp://admin.m2worlds.io/api/groupsync/roles/

Authorization

BearerAuth

Response

2004XX

Default Response

Body

application/json

name*string

identifiers*array of string

Request

JavaScriptCurl

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

Response

[
  {
    "name": "text",
    "identifiers": [
      "text"
    ]
  }
]

Post groupsync role

POSThttp://admin.m2worlds.io/api/groupsync/roles/

Authorization

BearerAuth

Body

application/json

name*string

identifiers*array of string

Response

2004XX

Default Response

Body

application/json

roleId*string

Request

JavaScriptCurl

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

Response

{
  "roleId": "text"
}

Patch groupsync role

PATCHhttp://admin.m2worlds.io/api/groupsync/roles/{roleName}

Authorization

BearerAuth

Path parameters

roleName*string

Body

application/json

itemsstring (email)

Response

2004XX

Default Response

Body

application/json

name*string

identifiers*array of string (email)

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/groupsync/roles/{roleName}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "[e-mail]"
    ]),
});
const data = await response.json();

Response

{
  "name": "text",
  "identifiers": [
    "[e-mail]"
  ]
}