Google is committed to advancing racial equity for Black communities. See how.

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,
  "runtimeType": enum (RuntimeType),
  "subscriptionType": enum (SubscriptionType),
  "projectId": string
}
Fields
name

string

Output only. Name of the Apigee organization.

displayName

string

Display name for the Apigee organization.

description

string

Description of the Apigee organization.

customerName

string

Not used by Apigee.

attributes[]

string

Not used by Apigee.

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.

analyticsRegion

string

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

runtimeType

enum (RuntimeType)

Output only. Runtime type of the Apigee organization based on the Apigee subscription purchased.

subscriptionType

enum (SubscriptionType)

Output only. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See Apigee pricing.

projectId

string

The project ID associated with the Apigee organization.

Type

Not used by Apigee.

Enums
TYPE_UNSPECIFIED Not used by Apigee.
TYPE_TRIAL Not used by Apigee.
TYPE_PAID Not used by Apigee.
TYPE_INTERNAL Not used by Apigee.

RuntimeType

Enums
RUNTIME_TYPE_UNSPECIFIED Runtime type not specified.
CLOUD Google-managed Apigee runtime.
HYBRID User-managed Apigee hybrid runtime.

SubscriptionType

Enums
SUBSCRIPTION_TYPE_UNSPECIFIED Subscription type not specified.
PAID Full subscription to Apigee has been purchased.
TRIAL Subscription to Apigee is free, limited, and used for evaluation purposes only.

Methods

create

Creates an Apigee organization.

get

Gets the profile for an Apigee organization.

getSyncAuthorization

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

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.