Worlds

Manages worlds configuration and lifecycle

Experimental feature: this API is likely to change.

Last updated 1 month ago

Was this helpful?

Get worlds for an organization

Retrieves and returns all worlds that belong to the given Organization. Can also additionally filter by project if a project ID is passed in the headers.

get

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstring

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

[
  {
    "queueState": null,
    "documentId": "text",
    "name": "text",
    "description": "text",
    "pictureUrl": "https://example.com",
    "transient": true,
    "organizationId": "text",
    "projectId": "text",
    "metadata": {
      "annotations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "manifest": {
      "serverPermissions": [
        "text"
      ],
      "clientPermissions": [
        "text"
      ]
    },
    "compute": {
      "version": "text",
      "group": "production",
      "region": "Europe"
    },
    "admission": {
      "capacity": 1,
      "policy": "Open"
    },
    "status": {
      "message": "text",
      "startedAt": "text",
      "runId": "text",
      "phase": "Inactive",
      "resolvedBuild": {
        "channelId": "text",
        "tag": "text",
        "organizationId": "text",
        "id": "text"
      }
    },
    "networking": {
      "strategy": "Default",
      "scaling": {
        "profile": "Small"
      }
    },
    "runtime": {
      "mapName": "text",
      "durationMinutes": 1,
      "capacity": 1,
      "admissionPolicy": "Open",
      "build": {
        "channelId": "text",
        "tag": "text",
        "content": {
          "id": "text"
        }
      }
    },
    "launchContext": {
      "launchContextId": "text",
      "name": "text",
      "isActive": true,
      "isWorldTravelOnly": true,
      "description": "text",
      "errorPageUrl": "text",
      "okPageUrl": "text",
      "bypassBrowserRestrictions": true,
      "enableQueue": true,
      "splashScreenUrl": "text",
      "useWorldSessions": true,
      "isPublic": true,
      "organizationId": "text",
      "projectId": "text",
      "artifactUrl": "text",
      "worldId": "text",
      "capacity": 1,
      "pictureUrl": "text",
      "permissionVerb": "*",
      "deployment": {
        "region": "text",
        "version": "text",
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "publicDownload": {
        "enabled": true,
        "enforceAntiCheat": true,
        "allowMac": true,
        "allowIos": true
      },
      "ubitusStreaming": {
        "gameLabel": "text",
        "gameChannel": "text"
      },
      "streamManager": {
        "streamContextId": "text",
        "allowForceProvider": true,
        "showProviderOptions": true,
        "useBuildVersion": true
      },
      "buildInfo": {
        "buildChannelId": "text",
        "buildTag": "text",
        "buildType": "client"
      },
      "gdnStreaming": {
        "cmsId": "text",
        "useCustomClient": true,
        "useWindowedMode": true,
        "authorizationId": "text",
        "launchMode": "same-tab"
      }
    }
  }
]

Lists all worlds for an organization or project (if specified)

Create a world

Creates a world in the given Organization and Project. Checks if the user can create a world with the given size.

post

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

namestring · min: 1 · max: 64required

The name of a world

Pattern: ^.+\S.*$

descriptionstring · max: 256

The description of a world

pictureUrlstring · uri

The picture URL of a world

transientbooleanrequired

Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.

metadataobject

The metadata of a world. Includes annotations and labels used to customize the world deployments.

manifestobject

The world manifest, describing server and client permissions.

computeobject · default: [object Object]

Includes details relating to the compute resources that are relevant for deploying the world.

admissionobject

networkingobject

The networking configuration of a world.

runtimeobjectrequired

streamingobject

The streaming configuration for a world

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","transient":true,"metadata":{"annotations":{},"labels":{}},"manifest":{"serverPermissions":[null],"clientPermissions":[null]},"compute":{},"admission":{"policy":"Open"},"networking":{"strategy":"Default","scaling":{"profile":"Small"}},"runtime":{"mapName":"text","admissionPolicy":"Open","build":{"channelId":"text","tag":"text","content":{"id":"text"}}},"streaming":{"streamManager":{"streamContextId":"text"},"ubitus":{"gameLabel":"text","gameChannel":"text"},"gdn":{"launchMode":"same-tab"}}}'

200

{
  "worldId": "text",
  "launchContextId": "text"
}

The world's ID, if created successfully

Service health check

get

/healthz

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/healthz'

200

text

Provides information about the service status.

Returns a list of worlds that the client can launch in to

get

/travel/locations/

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/travel/locations/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "worlds": [
    {
      "deployment": "text",
      "map": "text",
      "buildId": "text",
      "organizationId": "text",
      "projectId": "text",
      "launchContextId": "text",
      "launchContextName": "text",
      "worldId": "text",
      "worldName": "text",
      "liveConfigUrl": "text",
      "contentId": "text"
    }
  ]
}

List of worlds that the client can launch into

Get the details of a world

Retrieves and returns the specified world and linked launch context.

get

/{worldId}//

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

404

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": true,
  "organizationId": "text",
  "projectId": "text",
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "manifest": {
    "serverPermissions": [
      "text"
    ],
    "clientPermissions": [
      "text"
    ]
  },
  "compute": {
    "version": "text",
    "group": "production",
    "region": "Europe"
  },
  "admission": {
    "capacity": 1,
    "policy": "Open"
  },
  "status": {
    "message": "text",
    "startedAt": "text",
    "runId": "text",
    "phase": "Inactive",
    "resolvedBuild": {
      "channelId": "text",
      "tag": "text",
      "organizationId": "text",
      "id": "text"
    }
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Small"
    }
  },
  "runtime": {
    "mapName": "text",
    "durationMinutes": 1,
    "capacity": 1,
    "admissionPolicy": "Open",
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    }
  },
  "launchContext": {
    "launchContextId": "text",
    "name": "text",
    "isActive": true,
    "isWorldTravelOnly": true,
    "description": "text",
    "errorPageUrl": "text",
    "okPageUrl": "text",
    "bypassBrowserRestrictions": true,
    "enableQueue": true,
    "splashScreenUrl": "text",
    "useWorldSessions": true,
    "isPublic": true,
    "organizationId": "text",
    "projectId": "text",
    "artifactUrl": "text",
    "worldId": "text",
    "capacity": 1,
    "pictureUrl": "text",
    "permissionVerb": "*",
    "deployment": {
      "region": "text",
      "version": "text",
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "publicDownload": {
      "enabled": true,
      "enforceAntiCheat": true,
      "allowMac": true,
      "allowIos": true
    },
    "ubitusStreaming": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": true,
      "showProviderOptions": true,
      "useBuildVersion": true
    },
    "buildInfo": {
      "buildChannelId": "text",
      "buildTag": "text",
      "buildType": "client"
    },
    "gdnStreaming": {
      "cmsId": "text",
      "useCustomClient": true,
      "useWindowedMode": true,
      "authorizationId": "text",
      "launchMode": "same-tab"
    }
  }
}

The details for a world

Update the details of a world

Updates the specified world and returns the resulting new world data if successful.

patch

/{worldId}//

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

namestring · min: 1 · max: 64

The name of a world

Pattern: ^.+\S.*$

descriptionstring · max: 256

The description of a world

pictureUrlstring · uri

metadataobject

The metadata of a world. Includes annotations and labels used to customize the world deployments.

manifestobject

The world manifest, describing server and client permissions.

computeobject

Includes details relating to the compute resources that are relevant for deploying the world.

admissionobject

networkingobject

The networking configuration of a world.

runtimeobject

The world runtime fields that can be updated.

streamingobject

The streaming configuration for a world

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"metadata":{"annotations":{},"labels":{}},"manifest":{"serverPermissions":[null],"clientPermissions":[null]},"compute":{"group":"production","region":"Europe"},"admission":{"policy":"Open"},"networking":{"strategy":"Default","scaling":{"profile":"Small"}},"runtime":{"admissionPolicy":"Open","build":{"content":{"id":"text"}}},"streaming":{"streamManager":{"streamContextId":"text"},"ubitus":{"gameLabel":"text","gameChannel":"text"},"gdn":{"launchMode":"same-tab"}}}'

200

403

404

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": true,
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "manifest": {
    "serverPermissions": [
      "text"
    ],
    "clientPermissions": [
      "text"
    ]
  },
  "compute": {
    "version": "text",
    "group": "production",
    "region": "Europe"
  },
  "admission": {
    "capacity": 1,
    "policy": "Open"
  },
  "status": {
    "message": "text",
    "startedAt": "text",
    "runId": "text",
    "phase": "Inactive",
    "resolvedBuild": {
      "channelId": "text",
      "tag": "text",
      "organizationId": "text",
      "id": "text"
    }
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Small"
    }
  },
  "runtime": {
    "mapName": "text",
    "durationMinutes": 1,
    "capacity": 1,
    "admissionPolicy": "Open",
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    }
  }
}

The updated world details

Delete a world

Deletes the specified world.

delete

/{worldId}//

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

404

No body

Empty response

Get world bot deployments

Get all bot deployments for the specified world

get

/{worldId}/bots/

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

404

[
  {
    "documentId": "text",
    "description": "text",
    "organizationId": "text",
    "projectId": "text",
    "worldId": "text",
    "configuration": {
      "count": 1,
      "cpu": "/[a-z]/",
      "memory": "/[a-z]/",
      "durationMinutes": 1,
      "args": [
        "text"
      ]
    },
    "status": {
      "message": "text",
      "startedAt": 1,
      "worldStartedAt": "text",
      "phase": "Pending",
      "cluster": {
        "name": "text",
        "computeGroup": "text"
      }
    }
  }
]

All bot deployments for a world

Create world bot deployment

Create a bot deployment for the specified world with the provided bot count

post

/{worldId}/bots/

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

descriptionstring · max: 2048

countnumberrequired

cpustring · regex

Pattern: ^\d+(m|\.\d\d?\d?)?$

memorystring · regex

Pattern: ^\d+(\.\d+)?(m|k|Ki|M|Mi|G|Gi)?$

durationMinutesnumber

argsstring[]

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"count":1,"args":[null]}'

200

No body

Default Response

Get world bot deployment

Get the details for a specific bot deployment for the specified world.

get

/{worldId}/bots/{botDeploymentId}//

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

botDeploymentIdstringrequired

The ID of a bot deployment

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

404

{
  "documentId": "text",
  "description": "text",
  "organizationId": "text",
  "projectId": "text",
  "worldId": "text",
  "configuration": {
    "count": 1,
    "cpu": "/[a-z]/",
    "memory": "/[a-z]/",
    "durationMinutes": 1,
    "args": [
      "text"
    ]
  },
  "status": {
    "message": "text",
    "startedAt": 1,
    "worldStartedAt": "text",
    "phase": "Pending",
    "cluster": {
      "name": "text",
      "computeGroup": "text"
    }
  }
}

The details for a bot deployment

Update world bot deployment

Update a bot deployment for the specified world. This can be used to alter the bot count in a bot deployment.

patch

/{worldId}/bots/{botDeploymentId}//

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

botDeploymentIdstringrequired

The ID of a bot deployment

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

countnumberrequired

cpustring · regex

Pattern: ^\d+(m|\.\d\d?\d?)?$

memorystring · regex

Pattern: ^\d+(\.\d+)?(m|k|Ki|M|Mi|G|Gi)?$

durationMinutesnumber

argsstring[]

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"count":1,"args":[null]}'

200

No body

Default Response

Delete world bot deployment

Stop a bot deployment for the specified world

delete

/{worldId}/bots/{botDeploymentId}//

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

botDeploymentIdstringrequired

The ID of a bot deployment

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

No body

Default Response

Get world deployments

Returns the specified world's deployments. Optionally can be filtered by status, provided in the query string.

get

/{worldId}/deployments/

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Query parameters

statusany of[]

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/deployments/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

[
  {
    "organizationId": "text",
    "projectId": "text",
    "worldId": "text",
    "runId": "text",
    "createdAt": "text",
    "id": "text",
    "externalId": "text",
    "status": "Unknown",
    "compute": {
      "clusterName": "text",
      "version": "text",
      "group": "production",
      "region": "Europe"
    },
    "networking": {
      "scaling": {
        "profile": "Small"
      }
    },
    "runtime": {
      "mapName": "text",
      "liveConfigUrl": "text",
      "durationMinute": 1,
      "args": [
        "text"
      ],
      "build": {
        "channelId": "text",
        "id": "text",
        "content": {
          "id": "text"
        }
      }
    }
  }
]

Details for the World's deployments

World update picture URL

Update the picture URL of a world

patch

/{worldId}/pictureUrl/

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/pictureUrl/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

400

404

503

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": true,
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "manifest": {
    "serverPermissions": [
      "text"
    ],
    "clientPermissions": [
      "text"
    ]
  },
  "compute": {
    "version": "text",
    "group": "production",
    "region": "Europe"
  },
  "admission": {
    "capacity": 1,
    "policy": "Open"
  },
  "status": {
    "message": "text",
    "startedAt": "text",
    "runId": "text",
    "phase": "Inactive",
    "resolvedBuild": {
      "channelId": "text",
      "tag": "text",
      "organizationId": "text",
      "id": "text"
    }
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Small"
    }
  },
  "runtime": {
    "mapName": "text",
    "durationMinutes": 1,
    "capacity": 1,
    "admissionPolicy": "Open",
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    }
  }
}

The updated world details

Get a list of all active roles for a world

Returns a list of all active roles for a world. Could be used to get all possible conditions that allow a user to access a world.

get

/{worldId}/roles/

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/roles/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

[
  {
    "roleId": "text",
    "name": "text",
    "groupCondition": {
      "isActive": true,
      "capacity": 1,
      "guestToken": "text",
      "identifiers": [
        "text"
      ],
      "conditionType": "allUsers",
      "chainId": "1",
      "expiryDate": {
        "to": "text",
        "from": "text"
      }
    }
  }
]

The roles that can access a world

Start a world

Transitions the phase of the world to Starting, which will subsequently launch the underlying deployments. With this transition, the world run ID and startedAt timestamp are reset.

post

/{worldId}/start/

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/start/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

No body

Empty response

Stop a world

Transition the world phase to Stopped, which subsequently stops underlying deployments.

post

/{worldId}/stop/

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/stop/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

No body

Empty response

Check if a user has access to a world

get

/{worldId}/users/{userId}/access/

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

userIdstringrequired

The ID of a user

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/users/{userId}/access/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

{
  "userId": "text",
  "hasAccess": true
}

Indicates if a user has access to a world