Step 2: Create an organization

In this step, you create an Apigee organization.

To create a new organization and provision it:

1. On the command line, get your gcloud authentication credentials using the following command:

   Linux / MacOS

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

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

   echo $TOKEN

   This should display your token as an encoded string.

   Windows

   for /f "tokens=*" %a in ('gcloud auth print-access-token') do set TOKEN=%a

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

   echo %TOKEN%

   This should display your token as an encoded string.

2. In Step 1, you created the PROJECT_ID environment variable. Add these environment variables:

   Linux / MacOS

   export ORG_NAME=$PROJECT_ID
   export ANALYTICS_REGION="ANALYTICS_REGION"
   export RUNTIMETYPE=HYBRID

   Windows

   set ORG_NAME=$PROJECT_ID
   set ANALYTICS_REGION="ANALYTICS_REGION"
   set RUNTIMETYPE=HYBRID

   Where:

   • ORG_NAME (Required): This value must match the PROJECT_ID.
   • ANALYTICS_REGION (Required): The primary region for analytics data storage. For a list of available Apigee API Analytics regions, see Apigee locations.
   • RUNTIMETYPE (Required): Must be set to HYBRID.
3. Call the following Apigee API to create the organization:

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

   On a successful creation request, the organizations API responds 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 the state property in the response indicates, Apigee has started to create the new organization, so its state is IN_PROGRESS. This process can take several minutes.

   If you get an error, see Troubleshooting 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 was returned by the 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 of IN_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 is FINISHED. 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",
       "description": "",
       "createdAt": "1626237148461",
       "lastModifiedAt": "1626237149384",
       "properties": {
         "property": [
           {
             "name": "features.hybrid.enabled",
             "value": "true"
           },
           {
             "name": "features.mart.connect.enabled",
             "value": "true"
           }
         ]
       },
       "analyticsRegion": "ANALYTICS_REGION",
       "runtimeType": "HYBRID",
       "subscriptionType": "TRIAL",
       "state": "ACTIVE",
       "billingType": "EVALUATION",
       "expiresAt": "1631421073171",
       "addonsConfig": {
         "advancedApiOpsConfig": {},
         "integrationConfig": {},
         "monetizationConfig": {}
       }
     }
   }

6. You can use the Apigee organizations API to retrieve information about an organization after it is created. For example:

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

   The response to your request contains details about the specified organization in JSON format.

   {
     "name": "apigee-example",
     "createdAt": "1626237148461",
     "lastModifiedAt": "1626237149384",
     "properties": {
       "property": [
         {
           "name": "features.hybrid.enabled",
           "value": "true"
         },
         {
           "name": "features.mart.connect.enabled",
           "value": "true"
         }
       ]
     },
     "analyticsRegion": "us-west1",
     "runtimeType": "HYBRID",
     "subscriptionType": "TRIAL",
     "projectId": "apigee-example",
     "state": "ACTIVE",
     "billingType": "EVALUATION",
     "expiresAt": "1631421073171",
     "addonsConfig": {
       "advancedApiOpsConfig": {},
       "integrationConfig": {},
       "monetizationConfig": {}
     }
   }

Troubleshooting organization creation

When you create an organization with the Create 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 table lists errors you might receive and potential resolutions when you try to create a new organization:

Next step

Go to Step 3: Create an environment group.