Get Organization

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

API Resource Path: /organizations{org_name} or /o/{org_name}

Gets the profile for an organization

Verb: GET

Auth: Basic Auth

An organization is the fundamental container for all objects in an API provider's Apigee account, including APIs, API products, apps, and developers. 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 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

Last updated: about 1 month ago