organizations

Manages organizations, projects and launch contexts

Experimental feature: this API is likely to change.

Returns the details of an organization

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

Header parameters

Response

200

Default Response

Body

application/json

name*string

The name of an organization

tenantIdstring

pictureUrlstring

featuredEventIdstring

websiteInfoobject

featuresobject

legalPoliciesobject

hasEventEnabledboolean

organizationId*string

The ID of an organization

Request

JavaScriptCurlPython

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

Response

200

{
  "name": "text",
  "tenantId": "text",
  "pictureUrl": "text",
  "featuredEventId": "text",
  "websiteInfo": {
    "title": "text",
    "headTags": [
      "text"
    ]
  },
  "features": {
    "loginPanelDisclaimer": "text",
    "profilePictureUpload": false,
    "hasProfilePage": false,
    "hasCollectionsPage": false,
    "hasNavigationMenu": false,
    "allowPublicReadableChat": false,
    "loginOptions": {
      "hasEmail": false,
      "hasMetaMask": false,
      "hasWalletConnect": false,
      "hasCoinbaseWallet": false,
      "hasGoogle": false
    },
    "pubnub": {
      "publishKey": "text",
      "subscribeKey": "text",
      "defaultChannels": [
        {
          "read": false,
          "write": false,
          "type": "party"
        }
      ]
    }
  },
  "legalPolicies": {
    "termsOfService": [
      "text"
    ],
    "privacyPolicy": [
      "text"
    ],
    "chatRules": [
      "text"
    ],
    "nvidiaPrivacyPolicy": [
      "text"
    ],
    "eula": [
      "text"
    ]
  },
  "hasEventEnabled": false,
  "organizationId": "text"
}

Creates a new organization

POSThttps://your-organization-id.m2worlds.io/api/organizations/

Authorization

BearerAuth

Body

application/json

tenantIdstring

featuredEventIdstring

websiteInfoobject

featuresobject

legalPoliciesobject

hasEventEnabledboolean

name*string

The name of an organization

Response

200

Default Response

Body

application/json

organizationId*string

The ID of an organization

tenantId*string

Request

JavaScriptCurlPython

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

Response

200

{
  "organizationId": "text",
  "tenantId": "text"
}

Returns the details of an organization

GEThttps://your-organization-id.m2worlds.io/api/organizations/current/

Header parameters

Response

200

Default Response

Body

application/json

name*string

The name of an organization

tenantIdstring

pictureUrlstring

featuredEventIdstring

websiteInfoobject

featuresobject

legalPoliciesobject

hasEventEnabledboolean

organizationId*string

The ID of an organization

Request

JavaScriptCurlPython

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

Response

200

{
  "name": "text",
  "tenantId": "text",
  "pictureUrl": "text",
  "featuredEventId": "text",
  "websiteInfo": {
    "title": "text",
    "headTags": [
      "text"
    ]
  },
  "features": {
    "loginPanelDisclaimer": "text",
    "profilePictureUpload": false,
    "hasProfilePage": false,
    "hasCollectionsPage": false,
    "hasNavigationMenu": false,
    "allowPublicReadableChat": false,
    "loginOptions": {
      "hasEmail": false,
      "hasMetaMask": false,
      "hasWalletConnect": false,
      "hasCoinbaseWallet": false,
      "hasGoogle": false
    },
    "pubnub": {
      "publishKey": "text",
      "subscribeKey": "text",
      "defaultChannels": [
        {
          "read": false,
          "write": false,
          "type": "party"
        }
      ]
    }
  },
  "legalPolicies": {
    "termsOfService": [
      "text"
    ],
    "privacyPolicy": [
      "text"
    ],
    "chatRules": [
      "text"
    ],
    "nvidiaPrivacyPolicy": [
      "text"
    ],
    "eula": [
      "text"
    ]
  },
  "hasEventEnabled": false,
  "organizationId": "text"
}

Updates an organization

PATCHhttps://your-organization-id.m2worlds.io/api/organizations/current/

Authorization

BearerAuth

Header parameters

Body

application/json

namestring

The name of an organization

featuredEventIdstring

Response

200

Default Response

Request

JavaScriptCurlPython

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

Deletes an organization

DELETEhttps://your-organization-id.m2worlds.io/api/organizations/current/

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Request

JavaScriptCurlPython

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

Service health check

GEThttps://your-organization-id.m2worlds.io/api/organizations/healthz

Response

200

Default Response

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Returns the launch contexts of an organization

GEThttps://your-organization-id.m2worlds.io/api/organizations/launchContexts/

Header parameters

Response

200

Default Response

Body

application/json

launchContextId*string

name*string

isActive*boolean

publicDownloadany of

objectnull

isWorldTravelOnlyboolean

worldIdall of

descriptionstring

errorPageUrlstring

gdnStreamingany of

objectnull

ubitusStreamingany of

objectnull

streamManagerany of

objectnull

bypassBrowserRestrictionsboolean

enableQueueboolean

capacityany of

numbernull

buildInfoany of

objectnull

organizationId*string

The ID of an organization

projectId*string

The ID of a project

isPublicboolean

artifactUrlstring

permissionVerb*any of

enumenumenum

pictureUrlstring

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "launchContextId": "text",
    "name": "text",
    "isActive": false,
    "publicDownload": {
      "enabled": false,
      "enforceAntiCheat": false,
      "allowMac": false
    },
    "isWorldTravelOnly": false,
    "worldId": {},
    "description": "text",
    "errorPageUrl": "text",
    "gdnStreaming": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab",
      "useCustomClient": false,
      "useWindowedMode": false
    },
    "ubitusStreaming": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": false,
      "showProviderOptions": false,
      "useBuildVersion": false
    },
    "bypassBrowserRestrictions": false,
    "enableQueue": false,
    "capacity": 0,
    "buildInfo": {
      "buildChannelId": "text",
      "buildTag": "text",
      "buildType": "client"
    },
    "organizationId": "text",
    "projectId": "text",
    "isPublic": false,
    "artifactUrl": "text",
    "permissionVerb": "*",
    "pictureUrl": "text"
  }
]

Returns the projects of an organization

GEThttps://your-organization-id.m2worlds.io/api/organizations/projects/

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Body

application/json

itemsany of

objectobject

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "documentId": "text",
    "name": "text",
    "projectId": "text",
    "permissionVerb": "*"
  }
]

Creates a new project

POSThttps://your-organization-id.m2worlds.io/api/organizations/projects/

Authorization

BearerAuth

Header parameters

Body

application/json

name*string

The name of the project

Response

200

Default Response

Body

application/json

projectId*string

The ID of a project

Request

JavaScriptCurlPython

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

Response

200

{
  "projectId": "text"
}

Returns the details of a project

GEThttps://your-organization-id.m2worlds.io/api/organizations/projects/current/

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Body

application/json

documentId*string

name*string

The name of the project

permissionVerb*any of

enumenum

Request

JavaScriptCurlPython

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

Response

200

{
  "documentId": "text",
  "name": "text",
  "permissionVerb": "*"
}

Updates a project

PATCHhttps://your-organization-id.m2worlds.io/api/organizations/projects/current/

Authorization

BearerAuth

Header parameters

Body

application/json

documentIdstring

namestring

The name of the project

Response

200

Default Response

Body

application/json

documentIdstring

namestring

The name of the project

Request

JavaScriptCurlPython

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

Response

200

{
  "documentId": "text",
  "name": "text"
}

Deletes a project

DELETEhttps://your-organization-id.m2worlds.io/api/organizations/projects/current/

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Request

JavaScriptCurlPython

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

Updates the picture URL of an organization

PATCHhttps://your-organization-id.m2worlds.io/api/organizations/pictureUrl/

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Body

application/json

documentId*organizationId (string)

The ID of an organization

name*string

The name of an organization

tenantIdstring

pictureUrlstring

featuredEventIdstring

websiteInfoobject

featuresobject

legalPoliciesobject

hasEventEnabledboolean

Request

JavaScriptCurlPython

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

Response

200

{
  "documentId": "text",
  "name": "text",
  "tenantId": "text",
  "pictureUrl": "text",
  "featuredEventId": "text",
  "websiteInfo": {
    "title": "text",
    "headTags": [
      "text"
    ]
  },
  "features": {
    "loginPanelDisclaimer": "text",
    "profilePictureUpload": false,
    "hasProfilePage": false,
    "hasCollectionsPage": false,
    "hasNavigationMenu": false,
    "allowPublicReadableChat": false,
    "loginOptions": {
      "hasEmail": false,
      "hasMetaMask": false,
      "hasWalletConnect": false,
      "hasCoinbaseWallet": false,
      "hasGoogle": false
    },
    "pubnub": {
      "publishKey": "text",
      "subscribeKey": "text",
      "defaultChannels": [
        {
          "read": false,
          "write": false,
          "type": "party"
        }
      ]
    }
  },
  "legalPolicies": {
    "termsOfService": [
      "text"
    ],
    "privacyPolicy": [
      "text"
    ],
    "chatRules": [
      "text"
    ],
    "nvidiaPrivacyPolicy": [
      "text"
    ],
    "eula": [
      "text"
    ]
  },
  "hasEventEnabled": false
}

Returns the details of a slot organization

GEThttps://your-organization-id.m2worlds.io/api/organizations/slots/

Header parameters

Response

200

Default Response

Body

application/json

name*string

The name of an organization

tenantIdstring

pictureUrlstring

featuredEventIdstring

websiteInfoobject

featuresobject

legalPoliciesobject

hasEventEnabledboolean

organizationId*string

The ID of an organization

Request

JavaScriptCurlPython

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

Response

200

{
  "name": "text",
  "tenantId": "text",
  "pictureUrl": "text",
  "featuredEventId": "text",
  "websiteInfo": {
    "title": "text",
    "headTags": [
      "text"
    ]
  },
  "features": {
    "loginPanelDisclaimer": "text",
    "profilePictureUpload": false,
    "hasProfilePage": false,
    "hasCollectionsPage": false,
    "hasNavigationMenu": false,
    "allowPublicReadableChat": false,
    "loginOptions": {
      "hasEmail": false,
      "hasMetaMask": false,
      "hasWalletConnect": false,
      "hasCoinbaseWallet": false,
      "hasGoogle": false
    },
    "pubnub": {
      "publishKey": "text",
      "subscribeKey": "text",
      "defaultChannels": [
        {
          "read": false,
          "write": false,
          "type": "party"
        }
      ]
    }
  },
  "legalPolicies": {
    "termsOfService": [
      "text"
    ],
    "privacyPolicy": [
      "text"
    ],
    "chatRules": [
      "text"
    ],
    "nvidiaPrivacyPolicy": [
      "text"
    ],
    "eula": [
      "text"
    ]
  },
  "hasEventEnabled": false,
  "organizationId": "text"
}