Organization APIs

Resource: Organization

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "customerName": string,
  "attributes": [
    string
  ],
  "createdAt": string,
  "lastModifiedAt": string,
  "expiresAt": string,
  "environments": [
    string
  ],
  "properties": {
    object (Properties)
  },
  "type": enum (Type),
  "analyticsRegion": string,
  "authorizedNetwork": string,
  "runtimeType": enum (RuntimeType),
  "subscriptionType": enum (SubscriptionType),
  "billingType": enum (BillingType),
  "caCertificate": string,
  "runtimeDatabaseEncryptionKeyName": string,
  "projectId": string,
  "state": enum (State)
}
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.

expiresAt

string (int64 format)

Output only. Time that the Apigee organization is scheduled for deletion.

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 Apigee organization.

authorizedNetwork

string

Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See Getting started with the Service Networking API. Valid only when RuntimeType is set to CLOUD. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: default.

Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See Shared VPC overview. To use a shared VPC network, use the following format: projects/{host-project-id}/{region}/networks/{network-name}. For example: projects/my-sharedvpc-host/global/networks/mynetwork

Note: Not supported for Apigee hybrid.

runtimeType

enum (RuntimeType)

Required. Runtime type of the Apigee organization based on the Apigee subscription purchased.

subscriptionType
(deprecated)

enum (SubscriptionType)

Output only. DEPRECATED: This will eventually be replaced by BillingType. 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.

billingType

enum (BillingType)

Output only. Billing type of the Apigee organization. See Apigee pricing.

caCertificate

string (bytes format)

Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.

A base64-encoded string.

runtimeDatabaseEncryptionKeyName

string

Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created.

Required when RuntimeType is CLOUD. If not specified when RuntimeType is TRIAL, a Google-Managed encryption key will be used.

For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz".

Note: Not supported for Apigee hybrid.

projectId

string

Output only. Project ID associated with the Apigee organization.

state

enum (State)

Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use.

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.

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.

BillingType

Billing type of the Apigee organization.

Enums
BILLING_TYPE_UNSPECIFIED Billing type not specified.
SUBSCRIPTION A pre-paid subscription to Apigee.
EVALUATION Free and limited access to Apigee for evaluation purposes only. only.

Methods

create

Creates an Apigee organization.

delete

Delete 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.