Documentation

Unity Gaming Services CLI

GitHub Repository

Unity Gaming Services CLI

Project Roles

Reference the project roles required to run CLI commands for each UGS module.
Read time 2 minutesLast updated 21 hours ago
Project roles grant access to project-level data, which includes APIs that only apply to individual projects you choose. So to use some of the UGS CLI commands, you need to have the correct project roles linked to your project ID and Service Account. You can link the project roles to your Service Account and project ID under the 
Services Accounts
section in the Unity Dashboard. For more information, see Creating a Service Account. The tables below shows the project roles required to execute commands for each module.

Environment module

Project role

Description

Unity Environments Admin
Grants full access to all environments in a project.

Access module

Project role

Description

Unity Environments Admin
Grants full access to all environments in a project.
Player Resource Policy Editor
Grants write access to player-based resource policies.
Player Resource Policy Reader
Grants read access to player-based resource policies.
Project Resource Policy Editor
Grants write access to project-based resource policies.
Project Resource Policy Reader
Grants read access to project-based resource policies.

Cloud Code module

Project role

Description

Unity Environments Admin
Grants full access to all environments in a project.
Cloud Code Editor
Grants permissions necessary for viewing and editing cloud code resources.
Cloud Code Viewer
Grants permissions necessary for viewing cloud code resources.
Cloud Code Script Publisher
Grants permissions necessary for publishing cloud code scripts.

Lobby module

Project role

Description

Unity Environments Admin
Grants full access to all environments in a project.
Remote Config Admin
Grants access to the Remote Config admin API.

Player module

Project role

Description

Authentication Admin
Grants access to all Admin APIs for player authentication.
Authentication Editor
Grants access to all Admin APIs for player authentication.

Deploy Command

Currently Cloud Code, Remote Config and Economy services support the deploy command. To deploy for all services you need the following roles:

Project role

Description

Unity Environments Admin
Grants full access to all environments in a project.
Remote Config Admin
Grants access to the Remote Config admin API.
Cloud Code Script Editor
Grants permissions necessary for editing cloud code scripts.
Cloud Code Script Publisher
Grants permissions necessary for publishing cloud code scripts.
Cloud Code Script Viewer
Grants permissions necessary for viewing cloud code scripts.
Economy Resource Editor
Grants permissions necessary for creating, editing and deleting economy resources.
Economy Resource Publisher
Grants permissions necessary for publishing economy configurations.
Economy Resource Viewer
Grants permissions necessary for listing economy resources.

Fetch Command

Currently Remote Config services support the fetch command. To deploy for supported services you need the following roles:

Project role

Description

Unity Environments Admin
Grants full access to all environments in a project.
Remote Config Admin
Grants access to the Remote Config admin API.

Leaderboard module

Project role

Description

Unity Environments Admin
Grants full access to all environments in a project.
Leaderboards Admin
Grants access to the Leaderboard admin API.

Economy module

Project role

Description

Unity Environments Admin
Grants full access to all environments in a project.
Economy Resource Editor
Grants permissions necessary for creating, editing and deleting economy resources.
Economy Resource Publisher
Grants permissions necessary for publishing economy configurations.
Economy Resource Viewer
Grants permissions necessary for listing economy resources.