Method: projects.locations.workstationClusters.workstationConfigs.workstations.listUsable

Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.

HTTP request

GET https://workstations.googleapis.com/v1/{parent=projects/*/locations/*/workstationClusters/*/workstationConfigs/*}/workstations:listUsable

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Parent resource name.

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of items to return.
pageToken

string

Optional. nextPageToken value returned from a previous List request, if any.

Request body

The request body must be empty.

Response body

Response message for workstations.listUsable.

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

JSON representation 
{
  "workstations": [
    {
      object (Workstation)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
workstations[]

object (Workstation)

The requested workstations.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.
unreachable[]

string

Unreachable resources.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.