OBJECT

Organization

link GraphQL Schema definition

1type Organization {
2
3# The organization ID
4id: ID!
5
6# The organization GUID
7guid: ID
8
9# The organization's name
10name: String
11
12# A list of types applied to the organization, such
13# as `Broadcaster` or `Agency`.
14type: [String]
15
16# Applications belonging to the organization
17applications(offset: Int, limit: Int): ApplicationList
18
19# Freeform metadata in JSON format
20jsondata: JSONData
21
22createdDateTime: DateTime
23
24modifiedDateTime: DateTime
25
26seatLimit: Int
27
28# Organization's current status
29status: OrganizationStatus
30
31# Roles allowed within the organization
32roles: [Role]
33
34# Users belonging to the organization
35users(offset: Int, limit: Int): UserList
36
37# List of engines forbidden to this organization.
38blacklist: EngineBlacklist
39
40# List of engines allowed for this organization.
41# Takes precedence of the blacklist. That is, if a whitelist
42# is defined, then only engines in the whitelist are permitted
43# regardless of what is in the blacklist.
44# This field is not fully implemented!
45whitelist: EngineWhitelist
46
47# Custom schemas defined by this organization.
48# This field is not fully implemented!
49schemas: SchemaList
50
51# Watchlists for this organization.
52# This field is not fully implemented!
53watchlists: WatchlistList
54
55# Collections for this organization
56#
57# Arguments
58# name: Provide a name to filter by collection name
59# offset: Provide an offset to skip to a certain element in the
60# result, for paging.
61# limit: Specify maximum number of results to retrieve in this
62# result. Page size.
63collections(name: String, offset: Int, limit: Int): CollectionList
64
65# Folder tree for this organization
66#
67# Arguments
68# type: Specify a root folder type to retrieve a specific root
69# folder
70rootFolder(type: RootFolderType): Folder
71
72# Business unit
73businessUnit: String
74
75# Dashboards
76dashboards: [Dashboard]
77
78imageUrl: String
79
80# An ID corresponding to the organization used internally for some
81# provisioning elements. `applicationId` on `TemporalDataObject`, `Job`,
82# and some other types uses this value instead of the organization `id`.
83internalApplicationId: ID
84
85# The number of active seats
86seats: Int
87
88# The amount of media uploaded by this org in milliseconds
89mediaUsageMs: Int
90
91# Retrieve integration config of organization by integration id
92integrationConfig(id: ID!): IntegrationConfig
93
94# Configuration for authentication and directory integration
95# using Okta. By default, this feature is not used.
96oktaConfiguration: OktaConfiguration!
97
98priority: Int
99
100# Retrieve default cluster of organization
101defaultCluster: Cluster
102
103# The budget remaining for organization (cents)
104remainingBudget: Float
105
106# Enable/disable the limit enforced for organization
107isLimitEnforced: Boolean
108
109# Test
110testOrgField: Boolean
111
112# The pending cost of organization
113pendingCost: Float
114
115# Billing plan id
116billingPlanId: String
117
118# If TRUE, billing+plan_id has been updated
119billingDirty: Boolean
120
121# Last time billing was updated
122billingUpdatedDatetime: DateTime
123
124# How many hours processed per month
125monthlyProcessingHoursTotal: Float
126
127# How many bytes processed per month
128monthlyProcessingBytesTotal: Float
129
130# Storage for the month in bytes
131currentStorageBytes: Float
132
133# Storage for the month in ByteHrs
134monthlyBytehrsTotal: Float
135
136# Storage for the month in GB-HR
137monthlyGbhrTotal: Float
138
139# Storage for last month in ByteHrs
140lastMonthBytehrsTotal: Float
141
142# Storage for last month in GB-HR
143lastMonthGbhrTotal: Float
144
145# Processing last ran at this time
146monthlyProcessingLastran: DateTime
147
148# Storage last ran
149monthyStorageLastran: DateTime
150
151# Current Charge
152monthlyCurrentCharge: Float
153
154# Retrive notifications of org default mailbox
155notifications(
156dateTimeFilter: [NotificationDateTimeFilter!],
157offset: Int,
158limit: Int,
159orderBy: NotificationDateTimeField,
160orderDirection: OrderDirection,
161flags: [NotificationFlag!],
162flagsMode: filterCombineOperator
163): NotificationList
164
165# The flag to specify organization which require OpenId Connect
166requireOpenId: Boolean
167
168}