Documentation

​
​

Development

User Acquisition

Monetization

Industry

Unity Gaming Services CLI

v1.5

Legacy
​
GitHub Repository

Unity Gaming Services CLI

v1.5

Legacy
​
Unity Gaming Services CLI
​
​
Lobby
  • Overview
  • Commands
    • Bulk Update
    • Config Get
    • Config Update
    • Create
    • Delete
    • Export
    • Get
    • Get-Hosted
    • Get-Joined
    • Heartbeat
    • Import
    • Join
    • Player Remove
    • Player Update
    • Query
    • Quickjoin
    • Reconnect
    • Request-token
    • Update
  1. Overview
  3. Lobby

Request-token

Request a connection token for a player in a lobby.
Read time 1 minute
Last updated 3 months ago
Request a token
Authentication Required: 
Yes
ugs lobby request-token <lobby-id> <player-id> <type> [options]

Arguments

<lobby-id>
The ID of the lobby.
<player-id>
The ID of the player to impersonate.
<type>
The token type to request. Valid values are 
VivoxJoin
or 
WireJoin
.

Options

Alias

Description

service-id--service-id(REQUIRED) The service ID.
project-id-p, --project-idThe Unity cloud project ID.
environment-name-e, --environment-nameThe services environment name.
help-?, -h, --helpDisplay help and usage information.
quiet-q, --quietReduce logging to a minimum.
json-j, --jsonUse JSON as the output format.
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page

    • Arguments

    • Options