You've created a Google Cloud account and project and enabled the APIs. Now you can create yourorganization.

Prerequisite

To create an organization, you must meet one of the following conditions:

• Have an evaluation account. Evaluation accounts expire after 60 days. At that time, the organization willbe deleted.
• Have a paid account

If neither of these is true, then you must contactApigee Sales before you can continue.

To create a new organization and provision it:

1. On the command line, get yourgcloud authentication credentials, as the following example shows:

   TOKEN=$(gcloud auth print-access-token)

   To check that your token was populated, useecho, as the following example shows:

   echo $TOKEN

   This should display your token as an encoded string.

   For more information, seegcloud command-line tool overview.

2. Create the following environment variables for the elements of the organization. You will use these in the command to create the org.
   • PROJECT_ID(Required) is the Google Cloud project that you want bound to your new hybrid-enabled organization. This is the ID that Google generated for you inStep 2: Create a Google Cloud project.

     export PROJECT_ID=your_project_id

     Note: Do not include the period after the project ID.

     

   • ORG_NAME(Required) is the programmatic ID that you want for your hybrid-enabled organization.Note: The organization name must match your Google Cloud project ID.

     export ORG_NAME=$PROJECT_ID

   • ORG_DISPLAY_NAME(Optional) is the user-friendly name for your organization. This value does not need to be unique, and can include spaces and special characters. For example, "My Hybrid Organization".

     ORG_DISPLAY_NAME="friendly_name"

     Variable name contents that contain spaces must be enclosed in double quotes. For example: "My Organization"

   • ORGANIZATION_DESCRIPTION(Optional) is information about the organization that you'd like to use as a reminder of its purpose. For example, "My first organization".

     ORGANIZATION_DESCRIPTION="description_text"

   • ANALYTICS_REGION(Required) is the primary region for analytics data storage.

     export ANALYTICS_REGION=analytics_region

     Whereanalytics_region is one of the following:

     asia-northeast1	asia-south1	asia-east1	asia-southeast1
     australia-southeast1	us-central1	us-east1	us-west1
     asia-southeast2	europe-west1	europe-west2

     Choose a region that is geographically close or one that satisfies your organization's storage requirements.

   • RUNTIMETYPE(Required) is the runtime type of the Apigee organization, where HYBRID is user-managed Apigee hybrid runtime.

     export RUNTIMETYPE=HYBRID

   Tip: Use theecho $variable-name command to verify that the environment variables are properly set.
3. Send an authenticatedPOST request to theCreate organizations API.

   The following example shows the request structure that creates an organization:

   curl -H "Authorization: Bearer$TOKEN" -X POST -H "content-type:application/json" \  -d '{    "name":"'"$ORG_NAME"'",    "displayName":"'"$ORG_DISPLAY_NAME"'",    "description":"'"$ORGANIZATION_DESCRIPTION"'",    "runtimeType":"'"$RUNTIMETYPE"'",    "analyticsRegion":"'"$ANALYTICS_REGION"'"  }' \  "https://apigee.googleapis.com/v1/organizations?parent=projects/$PROJECT_ID"

   Tip:The quotation mark structure ("'") in the previous code sample is needed to pass the values of the environment variables within the JSON body.

   On a successful creation request, the organizations API should respond with a message similar to the following:

   {"name":"organizations/org_name/operations/long_running_operation_ID","metadata":{"@type":"type.googleapis.com/google.cloud.apigee.v1.OperationMetadata","operationType":"INSERT","targetResourceName":"organizations/org_name","state":"IN_PROGRESS"}}

   Where:

   • long_running_operation_ID is the UUID of an asynchronous, long-running operation. You can use this ID to check the status of your organization creation request (described in step 5).
   • org_name is the ID of your new organization that is currently being created.

   As thestate property in the response indicates, Apigee has started to create the new organization, so its state isIN_PROGRESS. This process can take several minutes.

   If you get an error, seeTroubleshooting organization creation.

4. Save the long-running operation ID to an environment variable. It will be useful for future management tasks.

   Syntax

   export LONG_RUNNING_OPERATION_ID=long_running_operation_ID

   Example

   export LONG_RUNNING_OPERATION_ID=6abc8a72-46de-f9da-bcfe-70d9ab347e4f

5. You can check the status of the long-running operation whose ID Apigee returned on your initial creation request. To do this, use the operations API. For example:

   curl -H "Authorization: Bearer$TOKEN" \  "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/operations/$LONG_RUNNING_OPERATION_ID"

   The following examples show possible responses to this request:

   IN_PROGRESS

   If Apigee is still creating the organization, Apigee responds with a status ofIN_PROGRESS. For example:

   {"name":"organizations/org_name/operations/long_running_operation_ID","metadata":{"@type":"type.googleapis.com/google.cloud.apigee.v1.OperationMetadata","operationType":"INSERT","targetResourceName":"organizations/org_name","state":"IN_PROGRESS"}}

   You should wait a little longer before attempting to verify that the creation process is complete.

   FINISHED

   When the organization has been provisioned, the state of the long-running operation isFINISHED. For example:

   {"name":"organizations/org_name/operations/long_running_operation_ID","metadata":{"@type":"type.googleapis.com/google.cloud.apigee.v1.OperationMetadata","operationType":"INSERT","targetResourceName":"organizations/org_name","state":"FINISHED"},"done":true,"response":{"@type":"type.googleapis.com/google.cloud.apigee.v1.Organization","name":"org_name","displayName":"display_name","description":"description","createdAt":"1600817805771","lastModifiedAt":"1600817805771","properties":{"property":[{"name":"features.hybrid.enabled","value":"true"},{"name":"features.mart.connect.enabled","value":"true"}]},"analyticsRegion":"us-central1","runtimeType":"HYBRID","subscriptionType":"TRIAL"}}

   If you did not enter a description, then that field does not appear in the response.

You have created a new organization and it is ready for you to use. Continue toStep 5: Add a domain and reserve a static IP.

View organization details

You can view the metadata details for the organization you created using an Apigee API. You can also use an API to list all of the organizations to which your Google Cloud account has access. To perform these actions, you use theorganizations API.

Before trying the APIs, refresh your authorization token:

TOKEN=$(gcloud auth print-access-token)

https://apigee.googleapis.com/v1/organizations/org_name

curl -H "Authorization: Bearer $TOKEN" \  "https://apigee.googleapis.com/v1/organizations/hybrid-example"

{"name":"organizations/org_name/operations/long_running_operation_ID","metadata":{"@type":"type.googleapis.com/google.cloud.apigee.v1.OperationMetadata","operationType":"INSERT","targetResourceName":"org_name","state":"FINISHED"},"done":true,"response":{"@type":"type.googleapis.com/google.cloud.apigee.v1.Organization","name":"org_name","displayName":"display_name","description":"description","createdAt":"1600817805771","lastModifiedAt":"1600817805771","properties":{"property":[{"name":"features.hybrid.enabled","value":"true"},{"name":"features.mart.connect.enabled","value":"true"}]},"analyticsRegion":"us-central1","runtimeType":"HYBRID","subscriptionType":"TRIAL"}}

https://apigee.googleapis.com/v1/organizations

curl -H "Authorization: Bearer $TOKEN" "https://apigee.googleapis.com/v1/organizations"

{  "organizations": [    {      "organization": "hybrid-example",      "projectIds": [        "hybrid-example"      ]    }  ]}

Troubleshooting organization creation

When you create an organization with theCreate organizations API, you might get an error response. Responses look like the following:

{  "error": {    "code":HTTP_error_code,    "message": "short_error_message",    "status": "high_level_error_type",    "details": [      {        "@type": "specific_error_type",        "detail": "expanded_error_description"      }    ]  }}

The following example shows a response to a common error—the organization ID containsillegal characters (uppercase characters are not allowed in organization IDs):

{"error":{"code":400,"message":"invalid Organization ID\"MY-ORG\":\"MY-ORG\" is an invalid Organization ID","status":"INVALID_ARGUMENT","details":[{"@type":"","detail":"[ORIGINAL ERROR] generic::invalid_argument: invalid Organization ID\"MY-ORG\":\"My-ORG\" is an invalid Organization ID [google.rpc.error_details_ext]{message:\"invalid Organization ID\\\"MY-ORG\\\":\\\"MY-ORG\\\" is an invalidOrganizationID\" }"}]}}

In this case, you could rename the organization with lowercase letters and resend your request.

The following table lists errors you might receive and potential resolutions when you try to create a new organization: