OBJECT
Organization
link GraphQL Schema definition
1 type Organization { 2 3 # The organization ID 4 : ID! 5 6 # The organization GUID 7 : ID 8 9 # The organization's name 10 : String 11 12 # A list of types applied to the organization, such 13 # as `Broadcaster` or `Agency`. 14 : [String] 15 16 # Applications belonging to the organization 17 (: Int, : Int): ApplicationList 18 19 # Freeform metadata in JSON format 20 : JSONData 21 22 : DateTime 23 24 : DateTime 25 26 : Int 27 28 # Organization's current status 29 : OrganizationStatus 30 31 # Roles allowed within the organization 32 # 33 # Arguments 34 # isAppEventRole: The flag to filter the application event 35 # handling roles 36 (: Boolean): [Role] 37 38 # Users belonging to the organization 39 (: Int, : Int): UserList 40 41 # List of engines forbidden to this organization. 42 : 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! 49 : EngineWhitelist 50 51 # Custom schemas defined by this organization. 52 # This field is not fully implemented! 53 : SchemaList 54 55 # Watchlists for this organization. 56 # This field is not fully implemented! 57 : 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. 67 (: String, : Int, : 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 74 (: RootFolderType): Folder 75 76 # Business unit 77 : String 78 79 # Dashboards 80 : [Dashboard] 81 82 : 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`. 87 : ID 88 89 # The number of active seats 90 : Int 91 92 # The amount of media uploaded by this org in milliseconds 93 : Int 94 95 # Retrieve integration config of organization by integration id 96 (: ID!): IntegrationConfig 97 98 # Configuration for authentication and directory integration 99 # using Okta. By default, this feature is not used. 100 : OktaConfiguration! 101 102 : Int 103 104 # Retrieve default cluster of organization 105 : Cluster 106 107 # The budget remaining for organization (cents) 108 : Float 109 110 # Enable/disable the limit enforced for organization 111 : Boolean 112 113 # Test 114 : Boolean 115 116 # The pending cost of organization 117 : Float 118 119 # Billing plan id 120 : String 121 122 # If TRUE, billing+plan_id has been updated 123 : Boolean 124 125 # Last time billing was updated 126 : DateTime 127 128 # How many hours processed per month 129 : Float 130 131 # How many bytes processed per month 132 : Float 133 134 # Storage for the month in bytes 135 : Float 136 137 # Storage for the month in ByteHrs 138 : Float 139 140 # Storage for the month in GB-HR 141 : Float 142 143 # Storage for last month in ByteHrs 144 : Float 145 146 # Storage for last month in GB-HR 147 : Float 148 149 # Processing last ran at this time 150 : DateTime 151 152 # Storage last ran 153 : DateTime 154 155 # Current Charge 156 : Float 157 158 # Retrive notifications of org default mailbox 159 ( 160 : [NotificationDateTimeFilter!], 161 : Int, 162 : Int, 163 : NotificationDateTimeField, 164 : OrderDirection, 165 : [NotificationFlag!], 166 : filterCombineOperator 167 ): NotificationList 168 169 # The flag to specify organization which require OpenId Connect 170 : Boolean 171 172 # Multi Organization Invite 173 ( 174 : ID, 175 : OrganizationInviteStatus, 176 : [OrganizationInviteStatus], 177 : OrganizationInviteType, 178 : String 179 ): [OrganizationInvite] 180 181 # The email got an invitation and waiting to complete the invitation 182 (: String): Boolean 183 184 # Display the package grants 185 : PackageGrantList 186 187 # it's a root org for the Instance 188 : Boolean 189 190 # For HUB to use 191 : Boolean 192 193 # The configuration for the organization's login screen 194 : LoginConfiguration 195 196 # The configuration for the organization's register screens 197 (: Int, : Int): RegistrationConfigurationList 198 199 : [DataRetentionPolicy!] 200 201 }
link Required by
- ApplicationRole
- ClusterCollaboratorA source ACL grants a single organization limited rights to a private clusters
- Collection
- Engine
- Folder
- Group
- JobPipelinedeprecated. DO NOT USE. TODO: Remove
- LibraryCollaborator
- LoginInfoContains information about the user's authentication context.
- Mention
- MutationMutations are used to modify data. Each mutation takes an input that contains the data necessary to create or update the data in question.
- OrganizationList
- QueryQueries are used to retrieve data. If you're new to our API, try the `me` query to explore the information you have access to. Hit `ctrl-space` at any time to activate field completion hints, and mouse over a field or parameter to see its documentation.
- SavedSearch
- ScheduledJob
- ScheduledJobCollaboratorA source ACL grants a single organization limited rights to a private source
- SourceA source represents a source of data and is used by adapters to ingest data into the platform for use by an engine workflow.
- SourceCollaboratorA source ACL grants a single organization limited rights to a private source
- StructuredJSONSchemaA custom structured data schema, specified in JSON. This type is not fully implemented.
- TemporalDataObject
- UserA user represents a user account within an organization.
- UserACL
- Watchlist
- Widget