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