Skip to main content

SystemPortal

The details of a system portal.

System portals are applications that you can install through the EventsAir App Store. Contrary to event portals, they are global to your environment.

There are different types of system portals that can help you manage various aspects of your event, such as single sign-on. For more information, see the document on system portals.

type SystemPortal {
  alias: String!
  brand: Brand!
  content: JSON!
  createdAt: DateTime!
  createdBy: String
  id: ID!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  liveFrom: DateTime
  liveTo: DateTime
  name: String!
  settings: JSON!
  type: String!
}

Fields

`SystemPortal.alias` ● `String!` non-null scalar

UTF-8 string value that represents the alias of the system portal. The alias is unique for a portal within an event.

An alias can only contain lower-case, alphameric and hyphen characters: [a-z0-9-].

`SystemPortal.brand` ● `Brand!` non-null object

The brand associated with the system portal.

`SystemPortal.content` ● `JSON!` non-null scalar

The content settings for the system portal.

`SystemPortal.createdAt` ● `DateTime!` non-null scalar

The date and time the record was created.

`SystemPortal.createdBy` ● `String` scalar

UTF-8 string value that represents the username of the user who created the record. Optional.

`SystemPortal.id` ● `ID!` non-null scalar

The unique identifier for the system portal.

`SystemPortal.lastModifiedAt` ● `DateTime!` non-null scalar

The date and time the record was last modified.

`SystemPortal.lastModifiedBy` ● `String` scalar

UTF-8 string value that represents the username of the user who last modified the record. Optional.

`SystemPortal.liveFrom` ● `DateTime` scalar

The date the system portal is live from. Optional.

`SystemPortal.liveTo` ● `DateTime` scalar

The date the system portal is live to. Optional.

`SystemPortal.name` ● `String!` non-null scalar

UTF-8 string value that represents the name of the system portal.

`SystemPortal.settings` ● `JSON!` non-null scalar

The settings of the system portal.

`SystemPortal.type` ● `String!` non-null scalar

UTF-8 string value that represents the type of the system portal.

Returned By

systemPortal query ● systemPortals query

Fields
Returned By