Organizations and users · GraphQL type

Organization type

A customer account: the tenant boundary for every endpoint, graph object, policy rule, and user. Every GraphObject carries the orgId of the organization that owns it, and that organization's dataRetentionPolicy decides how much history its searches can reach. Its status gates access: only an ENABLED organization accepts user sign-ins and endpoint enrollment. Retrieve one with organization.

Fields

Field Name Description
id - OrganizationId! The unique identifier of this Organization.
name - String! The display name of the Organization.
owners - [OrganizationContact!]! The contacts who own and administer this Organization.
status - OrganizationStatus! The lifecycle status of the Organization. Only ENABLED allows user authentication, endpoint authentication, and endpoint enrollment; a DISABLED organization still processes data its endpoints already submitted. New organizations start ENABLED.
statusUpdatedAt - Time! The time at which the Organization's status was last updated.
createdAt - Time! The time at which this Organization was created.
endpointDeploymentAddress - String! The address that endpoints connect to for this Organization's deployment.
dataRetentionPolicy - DataRetentionPolicy! How much historical data is retained for the Organization. New organizations start at DAYS_30.
dataRetentionPolicyUpdatedAt - Time! The time at which the data retention policy was last updated.
dataRetentionPolicyHistoryNow - Time! The oldest time available to search queries: midnight UTC today minus the number of days in the Organization's data retention policy.
entitlements - Entitlements! The entitlements granted to this Organization controlling resource limits.
entitlementsUpdatedAt - Time! The time at which the entitlements were last updated.
updatedAt - Time! The latest of createdAt, statusUpdatedAt, dataRetentionPolicyUpdatedAt, and entitlementsUpdatedAt.

Returned by

  • organization query: Retrieves an Organization: the customer tenant that owns every endpoint, graph object, policy rule, and user in its account, and sets their data…

Used by

Example

Example

{
  "id": "615f3b3b28284380e28a7342",
  "name": "abc123",
  "owners": [OrganizationContact],
  "status": "UNKNOWN",
  "statusUpdatedAt": "2021-10-07T18:23:25.829Z",
  "createdAt": "2021-10-07T18:23:25.829Z",
  "endpointDeploymentAddress": "xyz789",
  "dataRetentionPolicy": "DAYS_7",
  "dataRetentionPolicyUpdatedAt": "2021-10-07T18:23:25.829Z",
  "dataRetentionPolicyHistoryNow": "2021-10-07T18:23:25.829Z",
  "entitlements": Entitlements,
  "entitlementsUpdatedAt": "2021-10-07T18:23:25.829Z",
  "updatedAt": "2021-10-07T18:23:25.829Z"
}