Skip to main content

organizations

Creates, updates, deletes, gets or lists an organizations resource.

Overview​

Nameorganizations
TypeResource
Idgoogle.apigee.organizations

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringOutput only. Name of the Apigee organization.
addonsConfigobjectOptional. Addon configurations of the Apigee organization. (id: GoogleCloudApigeeV1AddonsConfig)
analyticsRegionstringRequired. DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud region for analytics data storage. For valid values, see Create an Apigee organization.
apiConsumerDataEncryptionKeyNamestringOptional. Cloud KMS key name used for encrypting API consumer data. If not specified or BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
apiConsumerDataLocationstringOptional. This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU.
apigeeProjectIdstringOutput only. Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee.
attributesarrayNot used by Apigee.
authorizedNetworkstringOptional. 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. When changing authorizedNetwork, you must reconfigure VPC peering. After VPC peering with previous network is deleted, run the following command: gcloud services vpc-peerings delete --network=NETWORK, where NETWORK is the name of the previous network. This will delete the previous Service Networking. Otherwise, you will get the following error: The resource 'projects/...-tp' is already linked to another shared VPC host 'projects/...-tp. 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.
billingTypestringOptional. Billing type of the Apigee organization. See Apigee pricing.
caCertificatestring (byte)Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD.
controlPlaneEncryptionKeyNamestringOptional. Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU". If not specified or BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
createdAtstring (int64)Output only. Time that the Apigee organization was created in milliseconds since epoch.
customerNamestringNot used by Apigee.
descriptionstringOptional. Description of the Apigee organization.
disableVpcPeeringbooleanOptional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Note: Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.
displayNamestringOptional. Display name for the Apigee organization. Unused, but reserved for future use.
environmentsarrayOutput only. List of environments in the Apigee organization.
expiresAtstring (int64)Output only. Time that the Apigee organization is scheduled for deletion.
lastModifiedAtstring (int64)Output only. Time that the Apigee organization was last modified in milliseconds since epoch.
networkEgressRestrictedbooleanOptional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is CLOUD and disable_vpc_peering is true.
portalDisabledbooleanOptional. Configuration for the Portals settings.
projectIdstringOutput only. Project ID associated with the Apigee organization.
propertiesobjectOptional. Properties defined in the Apigee organization profile. (id: GoogleCloudApigeeV1Properties)
runtimeDatabaseEncryptionKeyNamestringOptional. 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. If not specified or 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.
runtimeTypestringRequired. Runtime type of the Apigee organization based on the Apigee subscription purchased.
statestringOutput only. State of the organization. Values other than ACTIVE means the resource is not ready to use.
subscriptionPlanstringOutput only. Subscription plan that the customer has purchased. Output only.
subscriptionTypestringOutput 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.
typestringNot used by Apigee.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
organizations_getselectorganizationsIdGets the profile for an Apigee organization. See Understanding organizations.
organizations_listselectLists the Apigee organizations and associated Google Cloud projects that you have permission to access. See Understanding organizations.
organizations_createinsertparentCreates an Apigee organization. See Create an Apigee organization.
organizations_updatereplaceorganizationsIdUpdates the properties for an Apigee organization. No other fields in the organization profile will be updated.
organizations_deletedeleteorganizationsIdretentionDelete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed. The organization can be restored within the soft-deletion period, which is specified using the retention field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to MINIMUM.
organizations_set_sync_authorizationexecorganizationsIdSets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling setSyncAuthorization to ensure that you are updating the correct version. To get an ETag, call getSyncAuthorization. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.
organizations_set_addonsexecorganizationsIdConfigures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced.
organizations_security_assessment_results_batch_computeexecorganizationsIdCompute RAV2 security scores for a set of resources.
projects_provision_organizationexecprojectsIdProvisions a new Apigee organization with a functioning runtime. This is the standard way to create trial organizations for a free Apigee trial.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
organizationsIdstring
projectsIdstring
parentstring
retentionstring

SELECT examples​

Gets the profile for an Apigee organization. See Understanding organizations.

SELECT
name,
addonsConfig,
analyticsRegion,
apiConsumerDataEncryptionKeyName,
apiConsumerDataLocation,
apigeeProjectId,
attributes,
authorizedNetwork,
billingType,
caCertificate,
controlPlaneEncryptionKeyName,
createdAt,
customerName,
description,
disableVpcPeering,
displayName,
environments,
expiresAt,
lastModifiedAt,
networkEgressRestricted,
portalDisabled,
projectId,
properties,
runtimeDatabaseEncryptionKeyName,
runtimeType,
state,
subscriptionPlan,
subscriptionType,
type
FROM google.apigee.organizations
WHERE organizationsId = '{{ organizationsId }}' -- required;

INSERT examples​

Creates an Apigee organization. See Create an Apigee organization.

INSERT INTO google.apigee.organizations (
data__displayName,
data__description,
data__customerName,
data__attributes,
data__properties,
data__type,
data__analyticsRegion,
data__authorizedNetwork,
data__disableVpcPeering,
data__runtimeType,
data__billingType,
data__addonsConfig,
data__runtimeDatabaseEncryptionKeyName,
data__portalDisabled,
data__apiConsumerDataEncryptionKeyName,
data__controlPlaneEncryptionKeyName,
data__apiConsumerDataLocation,
data__networkEgressRestricted,
parent
)
SELECT 
'{{ displayName }}',
'{{ description }}',
'{{ customerName }}',
'{{ attributes }}',
'{{ properties }}',
'{{ type }}',
'{{ analyticsRegion }}',
'{{ authorizedNetwork }}',
{{ disableVpcPeering }},
'{{ runtimeType }}',
'{{ billingType }}',
'{{ addonsConfig }}',
'{{ runtimeDatabaseEncryptionKeyName }}',
{{ portalDisabled }},
'{{ apiConsumerDataEncryptionKeyName }}',
'{{ controlPlaneEncryptionKeyName }}',
'{{ apiConsumerDataLocation }}',
{{ networkEgressRestricted }},
'{{ parent }}'
RETURNING
name,
done,
error,
metadata,
response
;

REPLACE examples​

Updates the properties for an Apigee organization. No other fields in the organization profile will be updated.

REPLACE google.apigee.organizations
SET 
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__customerName = '{{ customerName }}',
data__attributes = '{{ attributes }}',
data__properties = '{{ properties }}',
data__type = '{{ type }}',
data__analyticsRegion = '{{ analyticsRegion }}',
data__authorizedNetwork = '{{ authorizedNetwork }}',
data__disableVpcPeering = {{ disableVpcPeering }},
data__runtimeType = '{{ runtimeType }}',
data__billingType = '{{ billingType }}',
data__addonsConfig = '{{ addonsConfig }}',
data__runtimeDatabaseEncryptionKeyName = '{{ runtimeDatabaseEncryptionKeyName }}',
data__portalDisabled = {{ portalDisabled }},
data__apiConsumerDataEncryptionKeyName = '{{ apiConsumerDataEncryptionKeyName }}',
data__controlPlaneEncryptionKeyName = '{{ controlPlaneEncryptionKeyName }}',
data__apiConsumerDataLocation = '{{ apiConsumerDataLocation }}',
data__networkEgressRestricted = {{ networkEgressRestricted }}
WHERE 
organizationsId = '{{ organizationsId }}' --required
RETURNING
name,
addonsConfig,
analyticsRegion,
apiConsumerDataEncryptionKeyName,
apiConsumerDataLocation,
apigeeProjectId,
attributes,
authorizedNetwork,
billingType,
caCertificate,
controlPlaneEncryptionKeyName,
createdAt,
customerName,
description,
disableVpcPeering,
displayName,
environments,
expiresAt,
lastModifiedAt,
networkEgressRestricted,
portalDisabled,
projectId,
properties,
runtimeDatabaseEncryptionKeyName,
runtimeType,
state,
subscriptionPlan,
subscriptionType,
type;

DELETE examples​

Delete an Apigee organization. For organizations with BillingType EVALUATION, an immediate deletion is performed. For paid organizations (Subscription or Pay-as-you-go), a soft-deletion is performed. The organization can be restored within the soft-deletion period, which is specified using the retention field in the request or by filing a support ticket with Apigee. During the data retention period specified in the request, the Apigee organization cannot be recreated in the same Google Cloud project. IMPORTANT: The default data retention setting for this operation is 7 days. To permanently delete the organization in 24 hours, set the retention parameter to MINIMUM.

DELETE FROM google.apigee.organizations
WHERE organizationsId = '{{ organizationsId }}' --required
AND retention = '{{ retention }}';

Lifecycle Methods​

Sets the permissions required to allow the Synchronizer to download environment data from the control plane. You must call this API to enable proper functioning of hybrid. Pass the ETag when calling setSyncAuthorization to ensure that you are updating the correct version. To get an ETag, call getSyncAuthorization. If you don't pass the ETag in the call to setSyncAuthorization, then the existing authorization is overwritten indiscriminately. For more information, see Configure the Synchronizer. Note: Available to Apigee hybrid only.

EXEC google.apigee.organizations.organizations_set_sync_authorization 
@organizationsId='{{ organizationsId }}' --required 
@@json=
'{
"identities": "{{ identities }}", 
"etag": "{{ etag }}"
}';