Method: organizations.providers.users.list

Lists all users.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*/providers/*}/users

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the identity provider. Use the following structure in your request: organizations/{org}/providers/{provider}

Query parameters

Parameters
startIndex

string

Starting index of the list.

count

string

Number of items.

sortBy

string

Field on which to sort the list.

sortOrder

string

Order in which to sort the list, such as ascending or descending.

filter

string

String used to filter the list.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "status": string,
  "message": string,
  "requestId": string,
  "errorCode": string,
  "data": [
    {
      object (ConsumerUser)
    }
  ]
}
Fields
status

string

Status of the operation.

message

string

Description of operation. message is a reserved word

requestId

string

ID that can be used to find request details in the log files.

errorCode

string

ID that can be used to find errors in the log files.

data[]

object (ConsumerUser)

List of users.

Authorization Scopes

Requires the following OAuth scope:

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