REST Resource: organizations

Resource: Organization

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "customerName": string,
  "attributes": [
    string
  ],
  "createdAt": string,
  "lastModifiedAt": string,
  "environments": [
    string
  ],
  "properties": {
    object (Properties)
  },
  "type": enum (Type),
  "analyticsRegion": string
}
Fields
name

string

Required. Name of the Apigee organization.

displayName

string

Optional.

description

string

Optional. Description of the Apigee organization.

customerName

string

Not used by Apigee hybrid.

attributes[]

string

Not used by Apigee hybrid.

createdAt

string (int64 format)

Output only. Time that the Apigee organization was created in milliseconds since epoch.

lastModifiedAt

string (int64 format)

Output only. Time that the Apigee organization was last modified in milliseconds since epoch.

environments[]

string

Output only. List of environments in the Apigee organization.

properties

object (Properties)

Properties defined in the Apigee organization profile.

type

enum (Type)

Not used by Apigee hybrid.

analyticsRegion

string

Required. Primary GCP region for analytics data storage. For valid values, see Create an organization.

Type

Enums
TYPE_UNSPECIFIED Subscription type not specified.
TYPE_TRIAL Subscription to Apigee is free, limited, and used for evaluation purposes only.
TYPE_PAID Full subscription to Apigee has been purchased. See Apigee pricing.
TYPE_INTERNAL For internal users only.

Methods

create

Creates an Apigee organization.

get

Gets the profile for an Apigee organization.

getMetrics

Gets metrics for an organization.

getSites

Lists details for all portals.

getSyncAuthorization

Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane.

getSystem

Gets the current state of the portal application.

list

Lists the Apigee organizations and associated GCP projects that you have permission to access.

setSyncAuthorization

Sets the permissions required to allow the Synchronizer to download environment data from the control plane.

update

Updates the properties for an Apigee organization.