Method: legacySoarSettings.legacyIsPermittedToEnvironment

Full name: projects.locations.instances.legacySoarSettings.legacyIsPermittedToEnvironment

legacySoarSettings.legacyIsPermittedToEnvironment checks if the user is permitted to the environment.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to check if the user is permitted to the environment for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
environmentName

string

Required. The environment to check if the user is permitted to the environment for.

Request body

The request body must be empty.

Response body

Response message for LegacySoarSettingService.LegacyIsPermittedToEnvironment.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "payload": boolean
}
Fields
payload

boolean

Output only. Whether the user is permitted to the environment.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.