Was this helpful?

 

API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path:

/organizations/{org_name} or /o/{org_name}

Description: Gets the profile for an organization on the Apigee Edge

Verb: GET
Auth: Basic Auth
Media types:
application/json
text/xml

Overview: An organization is the base container for all objects in an API provider's account on Apigee Edge. An organization contains API proxies, API products, apps, and developers, and the other entities supported by this API. A user account is required for each organization for which you may be a member. (Most users will have an account in only one organization.) You pass in your credentials (username and password) and the name of your organization with each API request you submit

The organizations parameter may be passed in as /organizations or as /o.

Organizations cannot be edited via the API.

Sample Request:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name} \
-u myname:mypass 

or 

$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/organizations/{org_name} \
-u myname:mypass
Sample Response:
{
  "createdAt" : 1336659666648,
  "createdBy" : "admin",
  "displayName" : "myorg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1336659666648,
  "lastModifiedBy" : "admin",
  "name" : "myorg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "paid",
  "users" : {
    "role" : [ ]
  }
}
Response Payload Elements:
Name Description
createdAt Unix time when the organization was created
createdBy User name of the Apigee user who created the organization
displayName Display name of the organization
environments Environments available in the organization (by default 'test' and 'prod' environments are available.
lastModifiedAt Unix time when the organization was last modified
name Internal name of the organization
properties A list of descriptors used internally by Apigee
type Organization type: currently 'trial' and 'paid' are valid
users A list of user and roles for the organization. Only populated for users in sysadmn role.
Errors
403 Forbidden

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)