REST Resource: organizations

Resource: Organization

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

JSON representation
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "etag": string,
  "directoryCustomerId": string
}
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

Output only. 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 Google Workspace customer that owns the organization.

state

enum (State)

Output only. The organization's current lifecycle state.

createTime

string (Timestamp format)

Output only. Timestamp when the Organization was created.

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".

updateTime

string (Timestamp format)

Output only. Timestamp when the Organization was last modified.

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".

deleteTime

string (Timestamp format)

Output only. Timestamp when the Organization was requested for deletion.

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".

etag

string

Output only. A checksum computed by the server based on the current value of the Organization resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

directoryCustomerId

string

Immutable. The G Suite / Workspace customer id used in the Directory API.

State

Organization lifecycle states.

Enums
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

get

Fetches an organization resource identified by the specified resource name.

getIamPolicy

Gets the access control policy for an organization 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.

testIamPermissions

Returns the permissions that a caller has on the specified organization.