1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Apigee
  7. \
  8. Resource
  9. \
  10. Organizations

Organizations

class Organizations extends Resource (View source)

The "organizations" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $organizations = $apigeeService->organizations;

Methods

GoogleLongrunningOperation
create(GoogleCloudApigeeV1Organization $postBody, array $optParams = [])

Creates an Apigee organization. See Create an Apigee organization. (organizations.create)

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

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.

GoogleCloudApigeeV1Organization
get(string $name, array $optParams = [])

Gets the profile for an Apigee organization. See Understanding organizations. (organizations.get)

GoogleCloudApigeeV1IngressConfig
getDeployedIngressConfig(string $name, array $optParams = [])

Gets the deployed ingress configuration for an organization.

GoogleCloudApigeeV1OrganizationProjectMapping
getProjectMapping(string $name, array $optParams = [])

Gets the project ID and region for an Apigee organization.

GoogleCloudApigeeV1RuntimeConfig
getRuntimeConfig(string $name, array $optParams = [])

Get runtime config for an organization. (organizations.getRuntimeConfig)

GoogleCloudApigeeV1SecuritySettings
getSecuritySettings(string $name, array $optParams = [])

GetSecuritySettings gets the security settings for API Security.

GoogleCloudApigeeV1SyncAuthorization
getSyncAuthorization(string $name, GoogleCloudApigeeV1GetSyncAuthorizationRequest $postBody, array $optParams = [])

Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to getSyncAuthorization. Pass that ETag when calling setSyncAuthorization to ensure that you are updating the correct version. 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.

GoogleCloudApigeeV1ListOrganizationsResponse
listOrganizations(string $parent, array $optParams = [])

Lists the Apigee organizations and associated Google Cloud projects that you have permission to access. See Understanding organizations.

GoogleLongrunningOperation
setAddons(string $org, GoogleCloudApigeeV1SetAddonsRequest $postBody, array $optParams = [])

Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced. (organizations.setAddons)

GoogleCloudApigeeV1SyncAuthorization
setSyncAuthorization(string $name, GoogleCloudApigeeV1SyncAuthorization $postBody, array $optParams = [])

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.

GoogleCloudApigeeV1Organization
update(string $name, GoogleCloudApigeeV1Organization $postBody, array $optParams = [])

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

GoogleCloudApigeeV1SecuritySettings
updateSecuritySettings(string $name, GoogleCloudApigeeV1SecuritySettings $postBody, array $optParams = [])

UpdateSecuritySettings updates the current security settings for API Security. (organizations.updateSecuritySettings)

Details

at line 55
GoogleLongrunningOperation create(GoogleCloudApigeeV1Organization $postBody, array $optParams = [])

Creates an Apigee organization. See Create an Apigee organization. (organizations.create)

Parameters

GoogleCloudApigeeV1Organization $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 88
GoogleLongrunningOperation delete(string $name, array $optParams = [])

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. (organizations.delete)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 105
GoogleCloudApigeeV1Organization get(string $name, array $optParams = [])

Gets the profile for an Apigee organization. See Understanding organizations. (organizations.get)

Parameters

string $name

Required. Apigee organization name in the following format: organizations/{org}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Organization

Exceptions

Exception

at line 126
GoogleCloudApigeeV1IngressConfig getDeployedIngressConfig(string $name, array $optParams = [])

Gets the deployed ingress configuration for an organization.

(organizations.getDeployedIngressConfig)

Parameters

string $name

Required. Name of the deployed configuration for the organization in the following format: 'organizations/{org}/deployedIngressConfig'.
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1IngressConfig

Exceptions

Exception

at line 142
GoogleCloudApigeeV1OrganizationProjectMapping getProjectMapping(string $name, array $optParams = [])

Gets the project ID and region for an Apigee organization.

(organizations.getProjectMapping)

Parameters

string $name

Required. Apigee organization name in the following format: organizations/{org}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1OrganizationProjectMapping

Exceptions

Exception

at line 157
GoogleCloudApigeeV1RuntimeConfig getRuntimeConfig(string $name, array $optParams = [])

Get runtime config for an organization. (organizations.getRuntimeConfig)

Parameters

string $name

Required. Name of the runtime config for the organization in the following format: 'organizations/{org}/runtimeConfig'.
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1RuntimeConfig

Exceptions

Exception

at line 173
GoogleCloudApigeeV1SecuritySettings getSecuritySettings(string $name, array $optParams = [])

GetSecuritySettings gets the security settings for API Security.

(organizations.getSecuritySettings)

Parameters

string $name

Required. The name of the SecuritySettings to retrieve. This will always be: 'organizations/{org}/securitySettings'.
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecuritySettings

Exceptions

Exception

at line 198
GoogleCloudApigeeV1SyncAuthorization getSyncAuthorization(string $name, GoogleCloudApigeeV1GetSyncAuthorizationRequest $postBody, array $optParams = [])

Lists the service accounts with the permissions required to allow the Synchronizer to download environment data from the control plane. An ETag is returned in the response to getSyncAuthorization. Pass that ETag when calling setSyncAuthorization to ensure that you are updating the correct version. 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.getSyncAuthorization)

Parameters

string $name

Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}
GoogleCloudApigeeV1GetSyncAuthorizationRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SyncAuthorization

Exceptions

Exception

at line 217
GoogleCloudApigeeV1ListOrganizationsResponse listOrganizations(string $parent, array $optParams = [])

Lists the Apigee organizations and associated Google Cloud projects that you have permission to access. See Understanding organizations.

(organizations.listOrganizations)

Parameters

string $parent

Required. Use the following structure in your request: organizations
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListOrganizationsResponse

Exceptions

Exception

at line 234
GoogleLongrunningOperation setAddons(string $org, GoogleCloudApigeeV1SetAddonsRequest $postBody, array $optParams = [])

Configures the add-ons for the Apigee organization. The existing add-on configuration will be fully replaced. (organizations.setAddons)

Parameters

string $org

Required. Name of the organization. Use the following structure in your request: organizations/{org}
GoogleCloudApigeeV1SetAddonsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 259
GoogleCloudApigeeV1SyncAuthorization setSyncAuthorization(string $name, GoogleCloudApigeeV1SyncAuthorization $postBody, array $optParams = [])

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. (organizations.setSyncAuthorization)

Parameters

string $name

Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}
GoogleCloudApigeeV1SyncAuthorization $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SyncAuthorization

Exceptions

Exception

at line 276
GoogleCloudApigeeV1Organization update(string $name, GoogleCloudApigeeV1Organization $postBody, array $optParams = [])

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

Parameters

string $name

Required. Apigee organization name in the following format: organizations/{org}
GoogleCloudApigeeV1Organization $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Organization

Exceptions

Exception

at line 296
GoogleCloudApigeeV1SecuritySettings updateSecuritySettings(string $name, GoogleCloudApigeeV1SecuritySettings $postBody, array $optParams = [])

UpdateSecuritySettings updates the current security settings for API Security. (organizations.updateSecuritySettings)

Parameters

string $name

Identifier. Full resource name is always organizations/{org}/securitySettings.
GoogleCloudApigeeV1SecuritySettings $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1SecuritySettings

Exceptions

Exception