Method: projects.instances.databases.databaseRoles.list

Lists Cloud Spanner database roles.

HTTP request

GET https://spanner.googleapis.com/v1/{parent=projects/*/instances/*/databases/*}/databaseRoles

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The database whose roles should be listed. Values are of the form projects/<project>/instances/<instance>/databases/<database>.

Authorization requires the following IAM permission on the specified resource parent:

  • spanner.databasesRoles.list

Query parameters

Parameters
pageSize

integer

Number of database roles to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
pageToken

string

If non-empty, pageToken should contain a nextPageToken from a previous ListDatabaseRolesResponse.

Request body

The request body must be empty.

Response body

The response for databaseRoles.list.

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

JSON representation 
{
  "databaseRoles": [
    {
      object (DatabaseRole)
    }
  ],
  "nextPageToken": string
}
Fields
databaseRoles[]

object (DatabaseRole)

Database roles that matched the request.
nextPageToken

string

nextPageToken can be sent in a subsequent databaseRoles.list call to fetch more of the matching roles.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

DatabaseRole

A Cloud Spanner database role.

JSON representation 
{
  "name": string
}
Fields
name

string

Required. The name of the database role. Values are of the form projects/<project>/instances/<instance>/databases/<database>/databaseRoles/<role> where <role> is as specified in the CREATE ROLE DDL statement.