Skip to main content

Authentication

The API uses two auth layers:

LayerUsed ByTypePurpose
OAuth2 (M2M)Your backend / PostmanClient credentialsManage sessions, send commands, watch streams, fetch recordings
Pool User TokenUnity SDKBearer tokenAuthenticate the device client

1. Get an M2M Access Token

The M2M token uses OAuth2 client credentials. In Postman, this is pre-configured at the collection level.

Token endpoint: https://id.beamxr.io/connect/token

Required scopes:

beamxr.api manage:streams manage:pool_users manage:videos manage:sessions manage:live_connections issue:pool_token

In Postman: open the collection's Authorization tab, enter your ClientId and ClientSecret, and click Get New Access Token.

2. Get a Pool User Token

With your M2M token active, call:

GET /poolusers/newtoken

This returns a bearer token. Copy it and paste it into your Unity SDK configuration to authenticate the client.