REST Resource: organizations

Resource: Organization

The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.

JSON representation 
{
  "name": string,
  "displayName": string,
  "owner": {
    object (OrganizationOwner)
  },
  "creationTime": string,
  "lifecycleState": enum (LifecycleState)
}
Fields
name

string

Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organizationId]". For example, "organizations/1234".
displayName

string

A human-readable string that refers to the Organization in the Google Cloud console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the G Suite customer that owns the organization.
owner

object (OrganizationOwner)

The owner of this Organization. The owner should be specified on creation. Once set, it cannot be changed. This field is required.
creationTime

string (Timestamp format)

Timestamp when the Organization was created. Assigned by the server.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lifecycleState

enum (LifecycleState)

The organization's current lifecycle state. Assigned by the server.

OrganizationOwner

The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the OrganizationOwner. If the OrganizationOwner is deleted, the Organization and all its descendants will be deleted.

JSON representation 
{

  // Union field owner_oneof can be only one of the following:
  "directoryCustomerId": string
  // End of list of possible types for union field owner_oneof.
}
Fields
Union field owner_oneof. The entity that owns an Organization. owner_oneof can be only one of the following:
directoryCustomerId

string

The G Suite customer id used in the Directory API.

LifecycleState

Organization lifecycle states.

Enums
LIFECYCLE_STATE_UNSPECIFIED Unspecified state. This is only useful for distinguishing unset values.
ACTIVE The normal and active state.
DELETE_REQUESTED The organization has been marked for deletion by the user.

Methods

clearOrgPolicy

 Clears a Policy from a resource.

get

 Fetches an Organization resource identified by the specified resource name.

getEffectiveOrgPolicy

 Gets the effective Policy on a resource.

getIamPolicy

 Gets the access control policy for an Organization resource.

getOrgPolicy

 Gets a Policy on a resource.

listAvailableOrgPolicyConstraints

 Lists Constraints that could be applied on the specified resource.

listOrgPolicies

 Lists all the Policies set for a particular resource.
Searches Organization resources that are visible to the user and satisfy the specified filter.

setIamPolicy

 Sets the access control policy on an Organization resource.

setOrgPolicy

 Updates the specified Policy on the resource.

testIamPermissions

 Returns permissions that a caller has on the specified Organization.