Method: organizations.consumers.access

Checks whether a developer has access to a resource.

HTTP request

POST https://apigee.googleapis.com/v1/{parent=organizations/*}/consumers/access

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the Apigee organization. Use the following structure in your  request: organizations/{org}

Request body

The request body contains an instance of CheckAccessBody.

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 (CheckAccessVerdict)
    }
  ]
}
Fields
status

string

Status of the operation.

message

string

Description of the operation.

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 (CheckAccessVerdict)

Results of the check access requests.

Authorization Scopes

Requires the following OAuth scope:

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

CheckAccessBody

JSON representation
{
  "data": [
    {
      object (CheckAccess)
    }
  ]
}
Fields
data[]

object (CheckAccess)

Resources to check access permissions.

CheckAccess

JSON representation
{
  "resourcePath": string,
  "action": enum (Action)
}
Fields
resourcePath

string

Resource path.

action

enum (Action)

Type of access requested for the provided resource path.

Action

Enums
view

CheckAccessVerdict

JSON representation
{
  "verdict": enum (Verdict),
  "action": enum (Action),
  "resourcePath": string
}
Fields
verdict

enum (Verdict)

Results of the check access request. "unknown" is returned if the resource path is not found

action

enum (Action)

Access that was attempted

resourcePath

string

Resource path.

Verdict

Enums
unknown Resource path not found.
allowed Access is allowed.
denied Access is denied.