BenchPrep GraphQL API API Reference

Welcome to BenchPrep GraphQL API documentation.

Its schema can be fetched using introspection query and can be used for generating code, documentations, tests etc.

GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

Please start looking by checking out our GraphQL Guides and supported operations

API Endpoints

Development Server:
http://benchprep.localhost/api/graphql
Integration Server:
https://integration.benchprep.com/api/graphql
Staging Server:
https://staging.benchprep.com/api/graphql
Production Server:
https://benchprep.com/api/graphql

Terms of Service: https://benchprep.com/terms

Contact: support@benchprep.com

Version: 0.1.0

Queries

BenchPrep's exposed queries

Queries

Request bannerMessages

Returns list of BannerMessagess.

filters:

BannerMessageFilter

(no description)

sort:

BannerMessageSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query bannerMessages($filters: BannerMessageFilter, $sort: BannerMessageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  bannerMessages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "query": "string",
    "state": "string",
    "destination": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

BannerMessageConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "bannerMessages": {
      "totalCount": "integer"
    }
  }
}

Queries

Request branchPlans

Returns list of BranchPlanss.

filters:

BranchPlanFilter

(no description)

sort:

BranchPlanSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query branchPlans($filters: BranchPlanFilter, $sort: BranchPlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  branchPlans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "query": "string",
    "branchId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

BranchPlanConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branchPlans": {
      "totalCount": "integer"
    }
  }
}

Queries

Request branches

Returns specific Branches.

filters:

BranchFilter

(no description)

sort:

BranchSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query branches($filters: BranchFilter, $sort: BranchSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  branches(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "parentBranchId": "string",
    "rootOnly": "boolean",
    "excludedBranchId": "string",
    "treeByBranchId": "string",
    "treeByBranchIdExcludingSelf": "string",
    "canHaveChildren": "boolean",
    "query": "string",
    "ancestorsByBranchId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

BranchConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branches": {
      "totalCount": "integer"
    }
  }
}

Queries

Request branding

Returns specific Branding.

Example

Request Content-Types: application/json

Query

query branding{
  branding{
    brandableId
    brandableType
    colorLogoUrl
    emailLogoUrl
    faviconUrl
    id
    mobileIconUrl
    primaryColor
    secondaryColor
    whiteLogoUrl
  }
}

Try it now

200 OK

Successful operation

type

Branding

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branding": {
      "brandableId": "string",
      "brandableType": "string",
      "colorLogoUrl": "string",
      "emailLogoUrl": "string",
      "faviconUrl": "string",
      "id": "string",
      "mobileIconUrl": "string",
      "primaryColor": "string",
      "secondaryColor": "string",
      "whiteLogoUrl": "string"
    }
  }
}

Queries

Request certificates

Returns list of Certificates.

filters:

CertificateFilter

(no description)

sort:

CertificateSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query certificates($filters: CertificateFilter, $sort: CertificateSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  certificates(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "contentPackageId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

CertificateConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "certificates": {
      "totalCount": "integer"
    }
  }
}

Queries

Request contentPackages

Returns list of ContentPackages.

filters:

ContentPackageFilter

(no description)

sort:

ContentPackageSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query contentPackages($filters: ContentPackageFilter, $sort: ContentPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  contentPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "query": "string",
    "state": "string",
    "excludedIds": [
      "string"
    ],
    "hasStudyPlan": "boolean",
    "hasCertificates": "boolean",
    "hasExams": "boolean",
    "bank": "boolean",
    "hasExternalPackages": "boolean",
    "enrolledFor": "number",
    "courseType": "string",
    "hasMilestones": "boolean",
    "isRecognitionIssuing": "boolean",
    "hasRecognitions": "boolean"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

ContentPackageConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "contentPackages": {
      "totalCount": "integer"
    }
  }
}

Queries

Request contentTypes

Returns list of ContentTypes.

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query contentTypes($offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  contentTypes(offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

ContentTypeConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "contentTypes": {
      "totalCount": "integer"
    }
  }
}

Queries

Request currentTenant

Returns information about the CurrentTenant (resolver).

Example

Request Content-Types: application/json

Query

query currentTenant{
  currentTenant{
    id
    name
    publicUrl
    slug
  }
}

Try it now

200 OK

Successful operation

type

CurrentTenant

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "currentTenant": {
      "id": "string",
      "name": "string",
      "publicUrl": "string",
      "slug": "string"
    }
  }
}

Queries

Request currentUser

Returns information about the currently authenticated CurrentUser (resolver).

Example

Request Content-Types: application/json

Query

query currentUser{
  currentUser{
    createdAt
    email
    id
    name
    permissionSlugs
    roleSlugs
    state
  }
}

Try it now

200 OK

Successful operation

type

CurrentUser

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "currentUser": {
      "email": "string",
      "id": "string",
      "name": "string",
      "permissionSlugs": [
        "string"
      ],
      "roleSlugs": [
        "string"
      ],
      "state": "string"
    }
  }
}

Queries

Request currentUserRole

Returns information about the currently authenticated UserRole.

Example

Request Content-Types: application/json

Query

query currentUserRole{
  currentUserRole{
    accessContext
    accessContextId
    accessContextType
    applicableAccessContexts
    id
    permissionSlugs(filter: $filter)
    properties
    roleSlug
    userId
  }
}

Try it now

200 OK

Successful operation

type

CurrentUserUserRole

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "currentUserRole": {
      "accessContextId": "string",
      "accessContextType": "string",
      "applicableAccessContexts": [
        null
      ],
      "id": "string",
      "permissionSlugs": [
        "string"
      ],
      "roleSlug": "string",
      "userId": "string"
    }
  }
}

Queries

Request developerTokens

Returns list of DeveloperTokenss.

sort:

DeveloperTokenSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query developerTokens($sort: DeveloperTokenSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  developerTokens(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

DeveloperTokenConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "developerTokens": {
      "totalCount": "integer"
    }
  }
}

Queries

Request domains

Returns registered Domains (resolver) to the current tenant.

filters:

DomainFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query domains($filters: DomainFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  domains(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ]
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

DomainsConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "domains": {
      "totalCount": "integer"
    }
  }
}

Queries

Request enrollments

Returns list of Enrollments.

filters:

EnrollmentFilter

(no description)

sort:

EnrollmentSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query enrollments($filters: EnrollmentFilter, $sort: EnrollmentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  enrollments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "contentPackageId": "string",
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

EnrollmentConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "enrollments": {
      "totalCount": "integer"
    }
  }
}

Queries

Request examResults

Returns list of ExamResults.

filters:

ExamResultFilter

(no description)

sort:

ExamResultSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query examResults($filters: ExamResultFilter, $sort: ExamResultSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  examResults(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "userId": [
      "string"
    ],
    "examId": "string",
    "examName": "string",
    "contentPackageId": "string",
    "query": "string",
    "withDeleted": "boolean"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

ExamResultConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "examResults": {
      "totalCount": "integer"
    }
  }
}

Queries

Request exams

Returns list of Exams.

filters:

ExamFilter

(no description)

sort:

ExamSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query exams($filters: ExamFilter, $sort: ExamSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  exams(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "contentPackageId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

ExamConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "exams": {
      "totalCount": "integer"
    }
  }
}

Queries

Request externalPackages

Returns list of ExternalPackages.

filters:

ExternalPackageFilter

(no description)

sort:

ExternalPackageSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query externalPackages($filters: ExternalPackageFilter, $sort: ExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  externalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "contentPackageId": "string",
    "withoutContentPackages": "boolean",
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

ExternalPackageConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "externalPackages": {
      "totalCount": "integer"
    }
  }
}

Queries

Request groups

Returns specific Groups.

filters:

GroupFilter

(no description)

sort:

GroupSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query groups($filters: GroupFilter, $sort: GroupSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  groups(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "query": "string",
    "branchId": "string",
    "memberId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

GroupConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "groups": {
      "totalCount": "integer"
    }
  }
}

Queries

Request integrations

Returns list of Integrations.

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query integrations($offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  integrations(offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

IntegrationConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "integrations": {
      "totalCount": "integer"
    }
  }
}

Queries

Request learningHubPages

Returns list of LearningHubPages.

sort:

LearningHubPageSortOrderFilter

(no description)

filters:

LearningHubPageFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query learningHubPages($sort: LearningHubPageSortOrderFilter, $filters: LearningHubPageFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  learningHubPages(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "sort": {
    "order": "string",
    "by": "string"
  },
  "filters": {
    "ids": [
      "string"
    ]
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

LearningHubPageConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "learningHubPages": {
      "totalCount": "integer"
    }
  }
}

Queries

Request learningPaths

Returns list of LearningPaths.

filters:

LearningPathFilter

(no description)

sort:

LearningPathSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query learningPaths($filters: LearningPathFilter, $sort: LearningPathSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  learningPaths(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

LearningPathConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "learningPaths": {
      "totalCount": "integer"
    }
  }
}

Queries

Request licenses

Returns list of Licenses.

filters:

LicenseFilter

(no description)

sort:

LicenseSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query licenses($filters: LicenseFilter, $sort: LicenseSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  licenses(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "userId": "string",
    "branchPlanIds": [
      "string"
    ],
    "userQuery": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

LicenseConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "licenses": {
      "totalCount": "integer"
    }
  }
}

Queries

Request locales

Returns specific Locales setup.

filters:

LocaleFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query locales($filters: LocaleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  locales(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "language": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

LocaleConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "locales": {
      "totalCount": "integer"
    }
  }
}

Queries

Request loginTrackings

Returns list of LoginTrackings.

sort:

LoginTrackingSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query loginTrackings($sort: LoginTrackingSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  loginTrackings(sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

LoginTrackingConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "loginTrackings": {
      "totalCount": "integer"
    }
  }
}

Queries

Request ltiDeployments

Returns list of LtiDeploymentss.

filters:

LtiDeploymentFilter

(no description)

sort:

LtiDeploymentSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query ltiDeployments($filters: LtiDeploymentFilter, $sort: LtiDeploymentSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  ltiDeployments(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "toolId": "string",
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

LtiDeploymentConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ltiDeployments": {
      "totalCount": "integer"
    }
  }
}

Queries

Request ltiTools

Returns list of LtiTools.

filters:

LtiToolFilter

(no description)

sort:

LtiToolSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query ltiTools($filters: LtiToolFilter, $sort: LtiToolSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  ltiTools(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "branchId": "string",
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

LtiToolConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ltiTools": {
      "totalCount": "integer"
    }
  }
}

Queries

Request messages

Returns list of Messages.

filters:

MessageFilter

(no description)

sort:

MessageSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query messages($filters: MessageFilter, $sort: MessageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  messages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ]
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

MessageConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "messages": {
      "totalCount": "integer"
    }
  }
}

Queries

Request milestones

Returns list of Milestones.

filters:

MilestoneFilter

(no description)

sort:

MilestoneSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query milestones($filters: MilestoneFilter, $sort: MilestoneSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  milestones(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "contentPackageId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

MilestoneConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "milestones": {
      "totalCount": "integer"
    }
  }
}

Queries

Request permissions

Returns list of Permissions.

filters:

PermissionFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query permissions($filters: PermissionFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  permissions(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "accessContexts": [
      "string"
    ]
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

PermissionConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "permissions": {
      "totalCount": "integer"
    }
  }
}

Queries

Request plans

Returns list of Planss.

filters:

PlanFilter

(no description)

sort:

PlanSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query plans($filters: PlanFilter, $sort: PlanSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  plans(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

PlanConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "plans": {
      "totalCount": "integer"
    }
  }
}

Queries

Request productCategories

Returns list of ProductCategorys.

filters:

ProductCategoryFilter

(no description)

sort:

ProductCategorySortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query productCategories($filters: ProductCategoryFilter, $sort: ProductCategorySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  productCategories(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "childOnly": "boolean"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

ProductCategoryConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productCategories": {
      "totalCount": "integer"
    }
  }
}

Queries

Request productCategoryAssignments

Returns list of ProductCategoryAssignments.

filters:

ProductCategoryAssignmentFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query productCategoryAssignments($filters: ProductCategoryAssignmentFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  productCategoryAssignments(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "forCategorizable": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

ProductCategoryAssignmentConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productCategoryAssignments": {
      "totalCount": "integer"
    }
  }
}

Queries

Request recognitionTypes

Returns list of RecognitionTypes.

filters:

RecognitionTypeFilter

(no description)

sort:

RecognitionTypeSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query recognitionTypes($filters: RecognitionTypeFilter, $sort: RecognitionTypeSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  recognitionTypes(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ]
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

RecognitionTypeConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "recognitionTypes": {
      "totalCount": "integer"
    }
  }
}

Queries

Request recognitions

Returns list of Recognitions.

filters:

RecognitionFilter

(no description)

sort:

RecognitionSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query recognitions($filters: RecognitionFilter, $sort: RecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  recognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "contentPackageId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

RecognitionConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "recognitions": {
      "totalCount": "integer"
    }
  }
}

Queries

Request roles

Returns list of Roles.

sort:

RoleSortOrderFilter

(no description)

filters:

RoleFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query roles($sort: RoleSortOrderFilter, $filters: RoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  roles(sort: $sort, filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "sort": {
    "order": "string",
    "by": "string"
  },
  "filters": {
    "ids": [
      "string"
    ],
    "notSlugs": [
      "string"
    ],
    "query": "string",
    "accessContexts": [
      "string"
    ]
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

RoleConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "roles": {
      "totalCount": "integer"
    }
  }
}

Queries

Request studyTasks

Returns list of StudyTasks.

filters:

StudyTaskFilter

(no description)

sort:

StudyTaskSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query studyTasks($filters: StudyTaskFilter, $sort: StudyTaskSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  studyTasks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "contentPackageId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

StudyTaskConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "studyTasks": {
      "totalCount": "integer"
    }
  }
}

Queries

Request subscriptions

Returns list of Subscriptions.

filters:

SubscriptionFilter

(no description)

sort:

SubscriptionSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query subscriptions($filters: SubscriptionFilter, $sort: SubscriptionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  subscriptions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "planIds": [
      "string"
    ],
    "userQuery": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

SubscriptionConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "subscriptions": {
      "totalCount": "integer"
    }
  }
}

Queries

Request userExternalPackages

Returns list of UserExternalPackages.

filters:

UserExternalPackageFilter

(no description)

sort:

UserExternalPackageSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query userExternalPackages($filters: UserExternalPackageFilter, $sort: UserExternalPackageSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  userExternalPackages(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "externalPackageId": "string",
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

UserExternalPackageConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userExternalPackages": {
      "totalCount": "integer"
    }
  }
}

Queries

Request userRecognitions

Returns list of UserRecognitions.

filters:

UserRecognitionFilter

(no description)

sort:

UserRecognitionSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query userRecognitions($filters: UserRecognitionFilter, $sort: UserRecognitionSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  userRecognitions(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "userId": "string",
    "contentPackageId": "string",
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

UserRecognitionConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRecognitions": {
      "totalCount": "integer"
    }
  }
}

Queries

Request userRoles

Returns list of UserRoles.

filters:

UserRoleFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query userRoles($filters: UserRoleFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  userRoles(filters: $filters, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "userId": "string",
    "containedUserIds": [
      "string"
    ]
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

UserRoleConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRoles": {
      "totalCount": "integer"
    }
  }
}

Queries

Request users

Returns list of Users.

filters:

UserFilter

(no description)

sort:

UserSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query users($filters: UserFilter, $sort: UserSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  users(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "excludedIds": [
      "string"
    ],
    "email": "string",
    "name": "string",
    "query": "string",
    "branchId": "string",
    "withoutBranch": "boolean",
    "roleSlug": "string",
    "withoutRole": "boolean",
    "withoutBranchPlanLicense": "string",
    "confirmationStatus": "string",
    "managersBranchId": "string",
    "groupId": "string",
    "managersGroupId": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

UserConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "users": {
      "totalCount": "integer"
    }
  }
}

Queries

Request virtualTrainings

Returns list of VirtualTrainings.

filters:

VirtualTrainingFilter

(no description)

sort:

VirtualTrainingSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query virtualTrainings($filters: VirtualTrainingFilter, $sort: VirtualTrainingSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  virtualTrainings(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

VirtualTrainingConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "virtualTrainings": {
      "totalCount": "integer"
    }
  }
}

Queries

Request vouchers

Returns list of Vouchers.

filters:

VoucherFilter

(no description)

sort:

VoucherSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query vouchers($filters: VoucherFilter, $sort: VoucherSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  vouchers(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "planIds": [
      "string"
    ],
    "branchPlanIds": [
      "string"
    ],
    "query": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

VoucherConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "vouchers": {
      "totalCount": "integer"
    }
  }
}

Queries

Request webhookDeliveries

Returns list of WebhookDeliveriess.

filters:

WebhookDeliveryFilter

(no description)

sort:

WebhookDeliverySortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query webhookDeliveries($filters: WebhookDeliveryFilter, $sort: WebhookDeliverySortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  webhookDeliveries(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "webhookIds": [
      "string"
    ],
    "webhookEventIds": [
      "string"
    ]
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

WebhookDeliveryConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "webhookDeliveries": {
      "totalCount": "integer"
    }
  }
}

Queries

Request webhookEvents

Returns list of WebhooksEventss.

filters:

WebhookEventFilter

(no description)

sort:

WebhookEventSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query webhookEvents($filters: WebhookEventFilter, $sort: WebhookEventSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  webhookEvents(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "eventType": "string",
    "startDate": "object",
    "endDate": "object"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

WebhookEventConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "webhookEvents": {
      "totalCount": "integer"
    }
  }
}

Queries

Request webhooks

Returns list of Webhookss.

filters:

WebhookFilter

(no description)

sort:

WebhookSortOrderFilter

(no description)

offset:

integer

Index of the first item in the records to be returned.

limit:

integer

Maximum number of records to be returned.

after:

string

Returns the elements in the list that come after the specified cursor.

before:

string

Returns the elements in the list that come before the specified cursor.

first:

integer

Returns the first n elements from the list.

last:

integer

Returns the last n elements from the list.

Example

Request Content-Types: application/json

Query

query webhooks($filters: WebhookFilter, $sort: WebhookSortOrderFilter, $offset: Int, $limit: Int, $after: String, $before: String, $first: Int, $last: Int){
  webhooks(filters: $filters, sort: $sort, offset: $offset, limit: $limit, after: $after, before: $before, first: $first, last: $last){
    totalCount
  }
}

Variables

{
  "filters": {
    "ids": [
      "string"
    ],
    "query": "string",
    "enabled": "boolean",
    "eventType": "string"
  },
  "sort": {
    "order": "string",
    "by": "string"
  },
  "offset": "integer",
  "limit": "integer",
  "after": "string",
  "before": "string",
  "first": "integer",
  "last": "integer"
}

Try it now

200 OK

Successful operation

type

WebhookConnection

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "webhooks": {
      "totalCount": "integer"
    }
  }
}

Mutations

BenchPrep's exposed mutations

Mutations

Modification bannerMessageCreate

Create BannerMessage resource.

input:

BannerMessageCreateInput

Parameters for BannerMessageCreateMutation

Example

Request Content-Types: application/json

Query

mutation bannerMessageCreate($input: BannerMessageCreateInput!){
  bannerMessageCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "body": "string",
    "startDate": "object",
    "endDate": "object",
    "destinations": [
      "string"
    ],
    "contentPackageId": "string",
    "userSegment": {
      "components": [
        {
          "componentId": "string",
          "componentType": "string",
          "accessContextId": "string",
          "accessContextType": "string"
        }
      ]
    },
    "eventTrigger": {
      "eventType": "string",
      "contentLocation": "string",
      "enabled": "boolean"
    }
  }
}

Try it now

200 OK

Successful operation

type

BannerMessageCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "bannerMessageCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification bannerMessageDelete

Delete BannerMessage resource.

input:

BannerMessageDeleteInput

Parameters for BannerMessageDeleteMutation

Example

Request Content-Types: application/json

Query

mutation bannerMessageDelete($input: BannerMessageDeleteInput!){
  bannerMessageDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

BannerMessageDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "bannerMessageDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification bannerMessageUpdate

Update BannerMessage resource.

input:

BannerMessageUpdateInput

Parameters for BannerMessageUpdateMutation

Example

Request Content-Types: application/json

Query

mutation bannerMessageUpdate($input: BannerMessageUpdateInput!){
  bannerMessageUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "body": "string",
    "destinations": [
      "string"
    ],
    "contentPackageId": "string",
    "startDate": "object",
    "endDate": "object",
    "eventTrigger": {
      "eventType": "string",
      "contentLocation": "string",
      "enabled": "boolean"
    }
  }
}

Try it now

200 OK

Successful operation

type

BannerMessageUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "bannerMessageUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification branchAssignUsers

Assign Users to Branch

input:

BranchAssignUsersInput

Parameters for BranchAssignUsersMutation

Example

Request Content-Types: application/json

Query

mutation branchAssignUsers($input: BranchAssignUsersInput!){
  branchAssignUsers(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "branchId": "string",
    "userIds": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

BranchAssignUsersMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branchAssignUsers": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification branchCreate

Create Branch resource.

input:

BranchCreateInput

Parameters for BranchCreateMutation

Example

Request Content-Types: application/json

Query

mutation branchCreate($input: BranchCreateInput!){
  branchCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "externalId": "string",
    "parentBranchId": "string"
  }
}

Try it now

200 OK

Successful operation

type

BranchCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branchCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification branchDelete

Delete Branch resource.

input:

BranchDeleteInput

Parameters for BranchDeleteMutation

Example

Request Content-Types: application/json

Query

mutation branchDelete($input: BranchDeleteInput!){
  branchDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

BranchDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branchDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification branchPlanCoursesUpdate

Update BranchPlan resource's courses.

input:

BranchPlanUpdateCoursesInput

Parameters for BranchPlanUpdateCoursesMutation

Example

Request Content-Types: application/json

Query

mutation branchPlanCoursesUpdate($input: BranchPlanUpdateCoursesInput!){
  branchPlanCoursesUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "contentPackageIdsToAdd": [
      "string"
    ],
    "contentPackageIdsToRemove": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

BranchPlanUpdateCoursesMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branchPlanCoursesUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification branchPlanCreate

Create BranchPlan resource.

input:

BranchPlanCreateInput

Parameters for BranchPlanCreateMutation

Example

Request Content-Types: application/json

Query

mutation branchPlanCreate($input: BranchPlanCreateInput!){
  branchPlanCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "externalId": "string",
    "branchId": "string",
    "validFrom": "object",
    "validTo": "object",
    "duration": "string",
    "seatCountType": "string",
    "firstActivationDate": "object",
    "lastActivationDate": "object",
    "finalAccessDate": "object",
    "finalAdminAccessDate": "object",
    "seatCount": "number",
    "concurrentUserLimit": "number",
    "enableInBrowse": "boolean",
    "contentPackageIds": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

BranchPlanCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branchPlanCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification branchPlanUpdate

Update BranchPlan resource.

input:

BranchPlanUpdateInput

Parameters for BranchPlanUpdateMutation

Example

Request Content-Types: application/json

Query

mutation branchPlanUpdate($input: BranchPlanUpdateInput!){
  branchPlanUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "externalId": "string",
    "enableInBrowse": "boolean",
    "validFrom": "object",
    "validTo": "object",
    "duration": "number",
    "seatCountType": "string",
    "firstActivationDate": "object",
    "lastActivationDate": "object",
    "finalAccessDate": "object",
    "finalAdminAccessDate": "object",
    "seatCount": "number",
    "concurrentUserLimit": "number",
    "durationUnit": "string"
  }
}

Try it now

200 OK

Successful operation

type

BranchPlanUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branchPlanUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification branchUpdate

Update Branch resource.

input:

BranchUpdateInput

Parameters for BranchUpdateMutation

Example

Request Content-Types: application/json

Query

mutation branchUpdate($input: BranchUpdateInput!){
  branchUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "externalId": "string",
    "slug": "string"
  }
}

Try it now

200 OK

Successful operation

type

BranchUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "branchUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification brandingDelete

Delete Branding resource.

input:

BrandingDeleteInput

Parameters for DeleteMutation

Example

Request Content-Types: application/json

Query

mutation brandingDelete($input: BrandingDeleteInput!){
  brandingDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "brandableId": "string",
    "brandableType": "string"
  }
}

Try it now

200 OK

Successful operation

type

DeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "brandingDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification colorUpdate

Update Color branding resource.

input:

ColorUpdateInput

Parameters for ColorUpdateMutation

Example

Request Content-Types: application/json

Query

mutation colorUpdate($input: ColorUpdateInput!){
  colorUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "primaryColor": "string",
    "secondaryColor": "string",
    "brandableId": "string",
    "brandableType": "string"
  }
}

Try it now

200 OK

Successful operation

type

ColorUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "colorUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification contentPackageNavigationItemsUpdate

Update NavigationItem resources.

input:

ContentPackageNavigationItemsUpdateInput

Parameters for ContentPackageNavigationItemsUpdateMutation

Example

Request Content-Types: application/json

Query

mutation contentPackageNavigationItemsUpdate($input: ContentPackageNavigationItemsUpdateInput!){
  contentPackageNavigationItemsUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "items": [
      {
        "itemType": "string",
        "landingPage": "boolean",
        "sortOrder": "number",
        "visible": "boolean",
        "configuration": "object"
      }
    ]
  }
}

Try it now

200 OK

Successful operation

type

ContentPackageNavigationItemsUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "contentPackageNavigationItemsUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification contentPackageUpdate

Unused and does not mutate any data. Will be removed 2024/03/21.

Update Enrollment resource.

input:

ContentPackageUpdateInput

Parameters for ContentPackageUpdateMutation

Example

Request Content-Types: application/json

Query

mutation contentPackageUpdate($input: ContentPackageUpdateInput!){
  contentPackageUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

ContentPackageUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "contentPackageUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification developerTokenCreate

Create DeveloperToken resource.

input:

DeveloperTokenCreateInput

Parameters for DeveloperTokenCreateMutation

Example

Request Content-Types: application/json

Query

mutation developerTokenCreate($input: DeveloperTokenCreateInput!){
  developerTokenCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string"
  }
}

Try it now

200 OK

Successful operation

type

DeveloperTokenCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "developerTokenCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification developerTokenDeactivate

Deactivate DeveloperToken resource.

input:

DeveloperTokenDeactivateInput

Parameters for DeveloperTokenDeactivateMutation

Example

Request Content-Types: application/json

Query

mutation developerTokenDeactivate($input: DeveloperTokenDeactivateInput!){
  developerTokenDeactivate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

DeveloperTokenDeactivateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "developerTokenDeactivate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification developerTokenUpdate

Update DeveloperToken resource.

input:

DeveloperTokenUpdateInput

Parameters for DeveloperTokenUpdateMutation

Example

Request Content-Types: application/json

Query

mutation developerTokenUpdate($input: DeveloperTokenUpdateInput!){
  developerTokenUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string"
  }
}

Try it now

200 OK

Successful operation

type

DeveloperTokenUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "developerTokenUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification enrollmentReset

Reset Enrollment resource.

input:

EnrollmentResetMutationInput

Parameters for EnrollmentResetMutation

Example

Request Content-Types: application/json

Query

mutation enrollmentReset($input: EnrollmentResetMutationInput!){
  enrollmentReset(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

EnrollmentResetMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "enrollmentReset": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification enrollmentUpdate

Update Enrollment resource.

input:

EnrollmentUpdateInput

Parameters for EnrollmentUpdateMutation

Example

Request Content-Types: application/json

Query

mutation enrollmentUpdate($input: EnrollmentUpdateInput!){
  enrollmentUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "additionalResets": "number"
  }
}

Try it now

200 OK

Successful operation

type

EnrollmentUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "enrollmentUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification examResultReset

Reset ExamResult resource.

input:

ExamResultResetMutationInput

Parameters for ExamResultResetMutation

Example

Request Content-Types: application/json

Query

mutation examResultReset($input: ExamResultResetMutationInput!){
  examResultReset(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

ExamResultResetMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "examResultReset": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification featureAccessUpdate

Update FeatureAccess resource.

input:

FeatureAccessUpdateInput

Parameters for FeatureAccessUpdateMutation

Example

Request Content-Types: application/json

Query

mutation featureAccessUpdate($input: FeatureAccessUpdateInput!){
  featureAccessUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "slug": "string",
    "allowed": "boolean",
    "controllableId": "string",
    "controllableType": "string"
  }
}

Try it now

200 OK

Successful operation

type

FeatureAccessUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "featureAccessUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification featureConfigurationUpdate

Update FeatureConfiguration resource.

input:

FeatureConfigurationUpdateInput

Parameters for FeatureConfigurationUpdateMutation

Example

Request Content-Types: application/json

Query

mutation featureConfigurationUpdate($input: FeatureConfigurationUpdateInput!){
  featureConfigurationUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "slug": "string",
    "controllableId": "string",
    "controllableType": "string",
    "configuration": "object"
  }
}

Try it now

200 OK

Successful operation

type

FeatureConfigurationUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "featureConfigurationUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification footerUpdate

Update Footer branding resource.

input:

PageComponentInput

Parameters for FooterUpdateMutation

Example

Request Content-Types: application/json

Query

mutation footerUpdate($input: PageComponentInput!){
  footerUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "variables": "object",
    "html": "string",
    "isDefault": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

FooterUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "footerUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification groupCreate

Group resource.

input:

GroupCreateInput

Parameters for GroupCreateMutation

Example

Request Content-Types: application/json

Query

mutation groupCreate($input: GroupCreateInput!){
  groupCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "branchId": "string",
    "externalId": "string",
    "description": "string"
  }
}

Try it now

200 OK

Successful operation

type

GroupCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "groupCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification groupMembershipUpdate

Update Group resource membership

input:

GroupMembershipUpdateInput

Parameters for GroupMembershipUpdateMutation

Example

Request Content-Types: application/json

Query

mutation groupMembershipUpdate($input: GroupMembershipUpdateInput!){
  groupMembershipUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "groupId": "string",
    "userIdsToAdd": [
      "string"
    ],
    "userIdsToRemove": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

GroupMembershipUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "groupMembershipUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification groupUpdate

Update Group resource.

input:

GroupUpdateInput

Parameters for GroupUpdateMutation

Example

Request Content-Types: application/json

Query

mutation groupUpdate($input: GroupUpdateInput!){
  groupUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "externalId": "string",
    "externalSystemId": "string",
    "description": "string"
  }
}

Try it now

200 OK

Successful operation

type

GroupUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "groupUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification groupsCreate

Queue asynchronous process to create multiple Group resources.

input:

GroupsCreateInput

Parameters for GroupsCreateMutation

Example

Request Content-Types: application/json

Query

mutation groupsCreate($input: GroupsCreateInput!){
  groupsCreate(input: $input){
    clientMutationId
    success
    uploadStatus
  }
}

Variables

{
  "input": {
    "fileName": "string",
    "dataFormat": "string",
    "groups": [
      {
        "name": "string",
        "branchSlug": "string",
        "externalId": "string",
        "description": "string"
      }
    ]
  }
}

Try it now

200 OK

Successful operation

type

GroupsCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "groupsCreate": {
      "clientMutationId": "string",
      "success": "boolean",
      "uploadStatus": "string"
    }
  }
}

Mutations

Modification integrationCreate

Create Integration resource.

input:

IntegrationCreateInput

Parameters for IntegrationCreateMutation

Example

Request Content-Types: application/json

Query

mutation integrationCreate($input: IntegrationCreateInput!){
  integrationCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "type": "string",
    "accountName": "string",
    "clientId": "string",
    "clientSecret": "string"
  }
}

Try it now

200 OK

Successful operation

type

IntegrationCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "integrationCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification integrationDelete

Delete Integration resource.

input:

IntegrationDeleteMutationInput

Parameters for IntegrationDeleteMutation

Example

Request Content-Types: application/json

Query

mutation integrationDelete($input: IntegrationDeleteMutationInput!){
  integrationDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

IntegrationDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "integrationDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification integrationUpdate

Update Integration resource.

input:

IntegrationUpdateInput

Parameters for IntegrationUpdateMutation

Example

Request Content-Types: application/json

Query

mutation integrationUpdate($input: IntegrationUpdateInput!){
  integrationUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "accountName": "string",
    "clientId": "string",
    "clientSecret": "string"
  }
}

Try it now

200 OK

Successful operation

type

IntegrationUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "integrationUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification learnableConfigurationUpdate

Update Learnable Configuration from a content package

input:

LearnableConfigurationUpdateInput

Parameters for LearnableConfigurationUpdateMutation

Example

Request Content-Types: application/json

Query

mutation learnableConfigurationUpdate($input: LearnableConfigurationUpdateInput!){
  learnableConfigurationUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "learnableType": "string",
    "learnableId": "string",
    "purchaseType": "string",
    "purchaseUrl": "string",
    "enableInBrowse": "boolean",
    "enableDisplayRecognitions": "boolean",
    "label": "string"
  }
}

Try it now

200 OK

Successful operation

type

LearnableConfigurationUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "learnableConfigurationUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification learningHubPageCreate

Create LearningHubPage resource.

input:

LearningHubPageCreateInput

Parameters for LearningHubPageCreateMutation

Example

Request Content-Types: application/json

Query

mutation learningHubPageCreate($input: LearningHubPageCreateInput!){
  learningHubPageCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "pageType": "string",
    "html": "string"
  }
}

Try it now

200 OK

Successful operation

type

LearningHubPageCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "learningHubPageCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification learningHubPageDelete

Delete LearningHubPage resource.

input:

LearningHubPageDeleteInput

Parameters for LearningHubPageDeleteMutation

Example

Request Content-Types: application/json

Query

mutation learningHubPageDelete($input: LearningHubPageDeleteInput!){
  learningHubPageDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

LearningHubPageDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "learningHubPageDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification learningHubPageUpdate

Update LearningHubPage resource.

input:

LearningHubPageUpdateInput

Parameters for LearningHubPageUpdateMutation

Example

Request Content-Types: application/json

Query

mutation learningHubPageUpdate($input: LearningHubPageUpdateInput!){
  learningHubPageUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "html": "string",
    "name": "string",
    "visible": "boolean",
    "sortOrder": "number"
  }
}

Try it now

200 OK

Successful operation

type

LearningHubPageUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "learningHubPageUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification learningHubPagesReorder

Reorder all LearningHubPage resources.

input:

LearningHubPagesReorderInput

Parameters for LearningHubPagesReorderMutation

Example

Request Content-Types: application/json

Query

mutation learningHubPagesReorder($input: LearningHubPagesReorderInput!){
  learningHubPagesReorder(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "learningHubPages": [
      {
        "id": "string",
        "html": "string",
        "name": "string",
        "visible": "boolean",
        "sortOrder": "number"
      }
    ]
  }
}

Try it now

200 OK

Successful operation

type

LearningHubPagesReorderMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "learningHubPagesReorder": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification licenseCreate

Create License resource.

input:

LicenseCreateInput

Parameters for LicenseCreateMutation

Example

Request Content-Types: application/json

Query

mutation licenseCreate($input: LicenseCreateInput!){
  licenseCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "userIds": [
      "string"
    ],
    "branchPlanId": "string",
    "planId": "string",
    "seatExclusion": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

LicenseCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "licenseCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification licenseRemove

Invalidate License resource.

input:

LicenseRemoveMutationInput

Parameters for LicenseRemoveMutation

Example

Request Content-Types: application/json

Query

mutation licenseRemove($input: LicenseRemoveMutationInput!){
  licenseRemove(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

LicenseRemoveMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "licenseRemove": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification licenseUpdate

Update License resource.

input:

LicenseUpdateInput

Parameters for LicenseUpdateMutation

Example

Request Content-Types: application/json

Query

mutation licenseUpdate($input: LicenseUpdateInput!){
  licenseUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "validUntil": "object"
  }
}

Try it now

200 OK

Successful operation

type

LicenseUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "licenseUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification localeUpdate

Update Locale resource.

input:

LocaleUpdateInput

Parameters for LocaleUpdateMutation

Example

Request Content-Types: application/json

Query

mutation localeUpdate($input: LocaleUpdateInput!){
  localeUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "number",
    "overrides": "object"
  }
}

Try it now

200 OK

Successful operation

type

LocaleUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "localeUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification ltiDeploymentCoursesUpdate

Update LtiDeployment resource's courses.

input:

LtiDeploymentUpdateCoursesInput

Parameters for LtiDeploymentUpdateCoursesMutation

Example

Request Content-Types: application/json

Query

mutation ltiDeploymentCoursesUpdate($input: LtiDeploymentUpdateCoursesInput!){
  ltiDeploymentCoursesUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "contentPackageIdsToAdd": [
      "string"
    ],
    "contentPackageIdsToRemove": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

LtiDeploymentUpdateCoursesMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ltiDeploymentCoursesUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification ltiDeploymentCreate

Create LtiDeployment resource.

input:

LtiDeploymentCreateInput

Parameters for LtiDeploymentCreateMutation

Example

Request Content-Types: application/json

Query

mutation ltiDeploymentCreate($input: LtiDeploymentCreateInput!){
  ltiDeploymentCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "externalId": "string",
    "toolId": "string",
    "branchId": "string",
    "enableNrps": "boolean",
    "contentPackageIds": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

LtiDeploymentCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ltiDeploymentCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification ltiDeploymentDelete

Delete LtiDeployment resource.

input:

LtiDeploymentDeleteInput

Parameters for LtiDeploymentDeleteMutation

Example

Request Content-Types: application/json

Query

mutation ltiDeploymentDelete($input: LtiDeploymentDeleteInput!){
  ltiDeploymentDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

LtiDeploymentDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ltiDeploymentDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification ltiDeploymentUpdate

Update Deployment resource.

input:

LtiDeploymentUpdateInput

Parameters for LtiDeploymentUpdateMutation

Example

Request Content-Types: application/json

Query

mutation ltiDeploymentUpdate($input: LtiDeploymentUpdateInput!){
  ltiDeploymentUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "externalId": "string",
    "branchId": "string",
    "enableNrps": "boolean",
    "ltiContextClaimType": "string"
  }
}

Try it now

200 OK

Successful operation

type

LtiDeploymentUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ltiDeploymentUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification ltiToolCreate

Create LtiTool resource.

input:

LtiToolCreateInput

Parameters for LtiToolCreateMutation

Example

Request Content-Types: application/json

Query

mutation ltiToolCreate($input: LtiToolCreateInput!){
  ltiToolCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "branchId": "string"
  }
}

Try it now

200 OK

Successful operation

type

LtiToolCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ltiToolCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification ltiToolDelete

Delete LtiTool resource.

input:

LtiToolDeleteInput

Parameters for LtiToolDeleteMutation

Example

Request Content-Types: application/json

Query

mutation ltiToolDelete($input: LtiToolDeleteInput!){
  ltiToolDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

LtiToolDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ltiToolDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification ltiToolUpdate

Update LtiTool resource.

input:

LtiToolUpdateInput

Parameters for LtiToolUpdateMutation

Example

Request Content-Types: application/json

Query

mutation ltiToolUpdate($input: LtiToolUpdateInput!){
  ltiToolUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "clientId": "string",
    "keysetUrl": "string",
    "oauth2Url": "string",
    "oauth2Aud": "string",
    "platformOidcAuthUrl": "string",
    "roleMapping": "object"
  }
}

Try it now

200 OK

Successful operation

type

LtiToolUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "ltiToolUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification marketingPageUpdate

Update MarketingPage branding resource.

input:

PageComponentInput

Parameters for MarketingPageUpdateMutation

Example

Request Content-Types: application/json

Query

mutation marketingPageUpdate($input: PageComponentInput!){
  marketingPageUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "variables": "object",
    "html": "string",
    "isDefault": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

MarketingPageUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "marketingPageUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification messageCreate

Create Message resource.

input:

MessageCreateInput

Parameters for MessageCreateMutation

Example

Request Content-Types: application/json

Query

mutation messageCreate($input: MessageCreateInput!){
  messageCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "title": "string",
    "body": "string",
    "contentPackageId": "string",
    "userSegment": {
      "components": [
        {
          "componentId": "string",
          "componentType": "string",
          "accessContextId": "string",
          "accessContextType": "string"
        }
      ]
    },
    "startDate": "object",
    "endDate": "object",
    "eventTrigger": {
      "eventType": "string",
      "contentLocation": "string",
      "enabled": "boolean"
    }
  }
}

Try it now

200 OK

Successful operation

type

MessageCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "messageCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification messageDelete

Delete Message resource.

input:

MessageDeleteInput

Parameters for MessageDeleteMutation

Example

Request Content-Types: application/json

Query

mutation messageDelete($input: MessageDeleteInput!){
  messageDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

MessageDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "messageDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification messageUpdate

Update Message resource.

input:

MessageUpdateInput

Parameters for MessageUpdateMutation

Example

Request Content-Types: application/json

Query

mutation messageUpdate($input: MessageUpdateInput!){
  messageUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "title": "string",
    "body": "string",
    "contentPackageId": "string",
    "startDate": "object",
    "endDate": "object",
    "eventTrigger": {
      "eventType": "string",
      "contentLocation": "string",
      "enabled": "boolean"
    }
  }
}

Try it now

200 OK

Successful operation

type

MessageUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "messageUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification planCreate

Create Plan resource.

input:

PlanCreateInput

Parameters for PlanCreateMutation

Example

Request Content-Types: application/json

Query

mutation planCreate($input: PlanCreateInput!){
  planCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "slug": "string",
    "externalId": "string",
    "validFrom": "string",
    "validTo": "string",
    "durationUnit": "string",
    "duration": "string",
    "finalAccessDate": "string",
    "firstActivationDate": "object",
    "kind": "string",
    "contentPackageIds": [
      "string"
    ],
    "planType": "string"
  }
}

Try it now

200 OK

Successful operation

type

PlanCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "planCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification planUpdate

Update Plan resource.

input:

PlanUpdateInput

Parameters for PlanUpdateMutation

Example

Request Content-Types: application/json

Query

mutation planUpdate($input: PlanUpdateInput!){
  planUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "externalId": "string",
    "validFrom": "string",
    "validTo": "string",
    "durationUnit": "string",
    "duration": "number",
    "finalAccessDate": "string",
    "firstActivationDate": "string"
  }
}

Try it now

200 OK

Successful operation

type

PlanUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "planUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification planUpdateAuthorizations

Update Plans authorizations.

input:

PlanUpdateAuthorizationsInput

Parameters for PlanUpdateAuthorizationsMutation

Example

Request Content-Types: application/json

Query

mutation planUpdateAuthorizations($input: PlanUpdateAuthorizationsInput!){
  planUpdateAuthorizations(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "contentPackageIdsToAdd": [
      "string"
    ],
    "contentPackageIdsToRemove": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

PlanUpdateAuthorizationsMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "planUpdateAuthorizations": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification productCategoryAssignmentsUpdate

Update ProductCategoryAssignment resource for a product.

input:

ProductCategoryAssignmentsUpdateInput

Parameters for ProductCategoryAssignmentsUpdateMutation

Example

Request Content-Types: application/json

Query

mutation productCategoryAssignmentsUpdate($input: ProductCategoryAssignmentsUpdateInput!){
  productCategoryAssignmentsUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "categorizableId": "string",
    "categorizableType": "string",
    "productCategoryIds": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

ProductCategoryAssignmentsUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "productCategoryAssignmentsUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification recognitionTypeCreate

Create RecognitionType resource.

input:

RecognitionTypeCreateInput

Parameters for RecognitionTypeCreateMutation

Example

Request Content-Types: application/json

Query

mutation recognitionTypeCreate($input: RecognitionTypeCreateInput!){
  recognitionTypeCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "awardType": "string"
  }
}

Try it now

200 OK

Successful operation

type

RecognitionTypeCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "recognitionTypeCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification recognitionTypeDelete

Delete RecognitionType resource.

input:

RecognitionTypeDeleteInput

Parameters for RecognitionTypeDeleteMutation

Example

Request Content-Types: application/json

Query

mutation recognitionTypeDelete($input: RecognitionTypeDeleteInput!){
  recognitionTypeDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

RecognitionTypeDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "recognitionTypeDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification recognitionTypeUpdate

Update RecognitionType resource.

input:

RecognitionTypeUpdateInput

Parameters for RecognitionTypeUpdateMutation

Example

Request Content-Types: application/json

Query

mutation recognitionTypeUpdate($input: RecognitionTypeUpdateInput!){
  recognitionTypeUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string"
  }
}

Try it now

200 OK

Successful operation

type

RecognitionTypeUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "recognitionTypeUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification roleCreate

Create Role resource.

input:

RoleCreateInput

Parameters for RoleCreateMutation

Example

Request Content-Types: application/json

Query

mutation roleCreate($input: RoleCreateInput!){
  roleCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "slug": "string",
    "name": "string",
    "permissionSlugs": [
      "string"
    ],
    "description": "string"
  }
}

Try it now

200 OK

Successful operation

type

RoleCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "roleCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification roleDelete

Delete Role resource.

input:

RoleDeleteMutationInput

Parameters for RoleDeleteMutation

Example

Request Content-Types: application/json

Query

mutation roleDelete($input: RoleDeleteMutationInput!){
  roleDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

RoleDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "roleDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification roleUpdate

Update Role resource.

input:

RoleUpdateInput

Parameters for RoleUpdateMutation

Example

Request Content-Types: application/json

Query

mutation roleUpdate($input: RoleUpdateInput!){
  roleUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "description": "string",
    "permissionSlugs": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

RoleUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "roleUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification subscriptionCreate

Deprecated by VoucherRedemption mutation

Create Subscription resource.

input:

SubscriptionCreateInput

Parameters for SubscriptionCreateMutation

Example

Request Content-Types: application/json

Query

mutation subscriptionCreate($input: SubscriptionCreateInput!){
  subscriptionCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "userId": "string",
    "voucherToken": "string"
  }
}

Try it now

200 OK

Successful operation

type

SubscriptionCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "subscriptionCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userActivate

Activate User resource.

input:

UserActivateMutationInput

Parameters for UserActivateMutation

Example

Request Content-Types: application/json

Query

mutation userActivate($input: UserActivateMutationInput!){
  userActivate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

UserActivateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userActivate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userCreate

Create User resource.

input:

UserCreateInput

Parameters for UserCreateMutation

Example

Request Content-Types: application/json

Query

mutation userCreate($input: UserCreateInput!){
  userCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "email": "string",
    "sisId": "string",
    "password": "string",
    "passwordConfirmation": "string"
  }
}

Try it now

200 OK

Successful operation

type

UserCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userDeactivate

Deactivate User resource.

input:

UserDeactivateMutationInput

Parameters for UserDeactivateMutation

Example

Request Content-Types: application/json

Query

mutation userDeactivate($input: UserDeactivateMutationInput!){
  userDeactivate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

UserDeactivateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userDeactivate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userRemoveGroups

Remove User from all associated Groups.

input:

UserRemoveGroupsInput

Parameters for UserRemoveGroupsMutation

Example

Request Content-Types: application/json

Query

mutation userRemoveGroups($input: UserRemoveGroupsInput!){
  userRemoveGroups(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string"
  }
}

Try it now

200 OK

Successful operation

type

UserRemoveGroupsMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRemoveGroups": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userRoleCreate

Create UserRole resource.

input:

UserRoleCreateInput

Parameters for UserRoleCreateMutation

Example

Request Content-Types: application/json

Query

mutation userRoleCreate($input: UserRoleCreateInput!){
  userRoleCreate(input: $input){
    clientMutationId
    creationGuard
    success
  }
}

Variables

{
  "input": {
    "userId": "string",
    "roleSlug": "string",
    "accessContextType": "string",
    "accessContextId": "string"
  }
}

Try it now

200 OK

Successful operation

type

UserRoleCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRoleCreate": {
      "clientMutationId": "string",
      "creationGuard": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userRoleDelete

Delete UserRole resource.

input:

UserRoleDeleteMutationInput

Parameters for UserRoleDeleteMutation

Example

Request Content-Types: application/json

Query

mutation userRoleDelete($input: UserRoleDeleteMutationInput!){
  userRoleDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

UserRoleDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRoleDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userRoleUpdate

Update UserRole resource.

input:

UserRoleUpdateInput

Parameters for UserRoleUpdateMutation

Example

Request Content-Types: application/json

Query

mutation userRoleUpdate($input: UserRoleUpdateInput!){
  userRoleUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "properties": "object"
  }
}

Try it now

200 OK

Successful operation

type

UserRoleUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRoleUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userRolesCreate

Create multiple UserRole resources in bulk.

input:

UserRolesCreateInput

Parameters for UserRolesCreateMutation

Example

Request Content-Types: application/json

Query

mutation userRolesCreate($input: UserRolesCreateInput!){
  userRolesCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "roleSlug": "string",
    "userIds": [
      "string"
    ],
    "accessContextType": "string",
    "accessContextId": "string"
  }
}

Try it now

200 OK

Successful operation

type

UserRolesCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRolesCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userRolesDelete

Delete multiple UserRole resources in bulk.

input:

UserRolesDeleteMutationInput

Parameters for UserRolesDeleteMutation

Example

Request Content-Types: application/json

Query

mutation userRolesDelete($input: UserRolesDeleteMutationInput!){
  userRolesDelete(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "userIds": [
      "string"
    ],
    "roleSlug": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

UserRolesDeleteMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRolesDelete": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userRolesDeleteByAccessContext

Delete multiple UserRole resources in bulk by AccessContext

input:

UserRolesDeleteByAccessContextInput

Parameters for UserRolesDeleteByAccessContextMutation

Example

Request Content-Types: application/json

Query

mutation userRolesDeleteByAccessContext($input: UserRolesDeleteByAccessContextInput!){
  userRolesDeleteByAccessContext(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "userId": "string",
    "accessContextType": "string",
    "accessContextId": "string"
  }
}

Try it now

200 OK

Successful operation

type

UserRolesDeleteByAccessContextMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRolesDeleteByAccessContext": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userRolesDeleteById

Delete multiple UserRole resources in bulk by ID

input:

UserRolesDeleteByIdMutationInput

Parameters for UserRolesDeleteByIdMutation

Example

Request Content-Types: application/json

Query

mutation userRolesDeleteById($input: UserRolesDeleteByIdMutationInput!){
  userRolesDeleteById(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "ids": [
      "string"
    ]
  }
}

Try it now

200 OK

Successful operation

type

UserRolesDeleteByIdMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userRolesDeleteById": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification userUpdate

Update User resource.

input:

UserUpdateInput

Parameters for UserUpdateMutation

Example

Request Content-Types: application/json

Query

mutation userUpdate($input: UserUpdateInput!){
  userUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "email": "string",
    "password": "string",
    "passwordConfirmation": "string",
    "sisId": "string",
    "extendedTimeAccommodation": "boolean"
  }
}

Try it now

200 OK

Successful operation

type

UserUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "userUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification usersCreate

Queue asynchronous process to create multiple User resources.

input:

UsersCreateInput

Parameters for UsersCreateMutation

Example

Request Content-Types: application/json

Query

mutation usersCreate($input: UsersCreateInput!){
  usersCreate(input: $input){
    clientMutationId
    success
    uploadStatus
  }
}

Variables

{
  "input": {
    "fileName": "string",
    "dataFormat": "string",
    "users": [
      {
        "name": "string",
        "email": "string",
        "password": "string",
        "sisId": "string"
      }
    ],
    "branchId": "string",
    "groupId": "string",
    "role": {
      "roleSlug": "string",
      "accessContextType": "string",
      "accessContextId": "string"
    },
    "branchPlanId": "string"
  }
}

Try it now

200 OK

Successful operation

type

UsersCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "usersCreate": {
      "clientMutationId": "string",
      "success": "boolean",
      "uploadStatus": "string"
    }
  }
}

Mutations

Modification voucherCreate

Create Voucher resource.

input:

VoucherCreateInput

Parameters for VoucherCreateMutation

Example

Request Content-Types: application/json

Query

mutation voucherCreate($input: VoucherCreateInput!){
  voucherCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "planId": "string",
    "branchPlanId": "string",
    "count": "number",
    "maxUseCount": "number",
    "token": "string"
  }
}

Try it now

200 OK

Successful operation

type

VoucherCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "voucherCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification voucherRedemption

Redeem a Voucher on behalf of a User.

input:

VoucherRedemptionInput

Parameters for VoucherRedemptionMutation

Example

Request Content-Types: application/json

Query

mutation voucherRedemption($input: VoucherRedemptionInput!){
  voucherRedemption(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "userId": "string",
    "voucherToken": "string"
  }
}

Try it now

200 OK

Successful operation

type

VoucherRedemptionMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "voucherRedemption": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification voucherUpdate

Update Voucher resource.

input:

VoucherUpdateInput

Parameters for VoucherUpdateMutation

Example

Request Content-Types: application/json

Query

mutation voucherUpdate($input: VoucherUpdateInput!){
  voucherUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "maxUseCount": "number"
  }
}

Try it now

200 OK

Successful operation

type

VoucherUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "voucherUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification webhookCreate

Create Webhook resource.

input:

WebhookCreateInput

Parameters for WebhookCreateMutation

Example

Request Content-Types: application/json

Query

mutation webhookCreate($input: WebhookCreateInput!){
  webhookCreate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "name": "string",
    "url": "string",
    "enabled": "boolean",
    "eventType": "string",
    "contentLocation": "string",
    "customHeaders": "object",
    "formatter": "string"
  }
}

Try it now

200 OK

Successful operation

type

WebhookCreateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "webhookCreate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification webhookResendDelivery

Resend delivery for a WebhookDelivery resource.

input:

WebhookResendDeliveryMutationInput

Parameters for WebhookResendDeliveryMutation

Example

Request Content-Types: application/json

Query

mutation webhookResendDelivery($input: WebhookResendDeliveryMutationInput!){
  webhookResendDelivery(input: $input){
    clientMutationId
    deliveryJobInProgress
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

WebhookResendDeliveryMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "webhookResendDelivery": {
      "clientMutationId": "string",
      "deliveryJobInProgress": "boolean",
      "success": "boolean"
    }
  }
}

Mutations

Modification webhookTest

Trigger a test event for a Webhook resource.

input:

WebhookTestMutationInput

Parameters for WebhookTestMutation

Example

Request Content-Types: application/json

Query

mutation webhookTest($input: WebhookTestMutationInput!){
  webhookTest(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "clientMutationId": "string"
  }
}

Try it now

200 OK

Successful operation

type

WebhookTestMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "webhookTest": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Mutations

Modification webhookUpdate

Update Webhook resource.

input:

WebhookUpdateInput

Parameters for WebhookUpdateMutation

Example

Request Content-Types: application/json

Query

mutation webhookUpdate($input: WebhookUpdateInput!){
  webhookUpdate(input: $input){
    clientMutationId
    success
  }
}

Variables

{
  "input": {
    "id": "string",
    "name": "string",
    "url": "string",
    "enabled": "boolean",
    "eventType": "string",
    "contentLocation": "string",
    "customHeaders": "object"
  }
}

Try it now

200 OK

Successful operation

type

WebhookUpdateMutationPayload

Response Content-Types: application/json

Response Example (200 OK)

{
  "data": {
    "webhookUpdate": {
      "clientMutationId": "string",
      "success": "boolean"
    }
  }
}

Schema Definitions

AccessContext:

An AccessContext specifies the logical grouping of resources to which a UserRole has access

Example

AccessContextEnum: string

object Branch: Permission has access to Branch context.
object ContentPackage: Permission has access to ContentPackage context.
object Group: Permission has access to Group context.
object System: Permission has access to System context.
object Tenant: Permission has access to Tenant context.

AccessTokenRedemption: object

Represents information about a Voucher redemption

createdAt: object: Timestamp when the Voucher was redeemed.
return: ISO8601DateTime arguments: object
id: object: ID of the AccessTokenRedemption.
return: ID arguments: object
license: object: License associated with the AccessTokenRedemption.
return: License arguments: object
user: object: User associated with the AccessTokenRedemption.
return: User arguments: object

Example

{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "license": {
    "return": {
      "activatedAt": {
        "return": "object",
        "arguments": {}
      },
      "branchPlan": {
        "return": {
          "activatedLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "activeLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "availableSeatCount": {
            "return": "number",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

AccessTokenRedemptionFilter: object

Input fields for voucher search

userQuery: String: Smart search across User ID, SIS ID, name, and email

Example

{
  "userQuery": "string"
}

AccessTokenRedemptionSortAttributes: string

object id: Sort by ID
object user_id: Sort by the User ID
object created_at: Sort by time of redmeption

AccessTokenRedemptionSortOrderFilter: object

order: SortOrder
by: AccessTokenRedemptionSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

AccessTokenRedemptionsConnection: object

The connection type for AccessTokenRedemption.

edges: object: A list of edges.
return: AccessTokenRedemptionsEdge arguments: object
nodes: object: A list of nodes.
return: AccessTokenRedemption arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "license": {
              "return": {
                "activatedAt": {
                  "return": "object",
                  "arguments": {}
                },
                "branchPlan": {
                  "return": {
                    "activatedLicenseCount": {
                      "return": "number",
                      "arguments": {}
                    },
                    "activeLicenseCount": {
                      "return": "number",
                      "arguments": {}
                    },
                    "availableSeatCount": {
                      "return": "number",
                      "arguments": {}
                    },
                    "branch": {
                      "return": {
                        "appliedBranding": {
                          "return": {
                            "brandableId": {
                              "return": "string",
                              "arguments": {}
                            },
                            "brandableType": {
                              "return": "string",
                              "arguments": {}
                            },
                            "colorLogoUrl": {
                              "return": "string",
                              "arguments": {}
                            },
                            "emailLogoUrl": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconUrl": {
                              "return": "string",
                              "arguments": {}
                            },
                            "footer": {
                              "return": {
                                "html": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "id": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "isDefault": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "variables": {
                                  "return": "object",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "marketingPage": {
                              "return": {
                                "html": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "id": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

AccessTokenRedemptionsEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: AccessTokenRedemption arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "license": {
        "return": {
          "activatedAt": {
            "return": "object",
            "arguments": {}
          },
          "branchPlan": {
            "return": {
              "activatedLicenseCount": {
                "return": "number",
                "arguments": {}
              },
              "activeLicenseCount": {
                "return": "number",
                "arguments": {}
              },
              "availableSeatCount": {
                "return": "number",
                "arguments": {}
              },
              "branch": {
                "return": {
                  "appliedBranding": {
                    "return": {
                      "brandableId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "brandableType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "colorLogoUrl": {
                        "return": "string",
                        "arguments": {}
                      },
                      "emailLogoUrl": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconUrl": {
                        "return": "string",
                        "arguments": {}
                      },
                      "footer": {
                        "return": {
                          "html": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "string",
                            "arguments": {}
                          },
                          "isDefault": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "variables": {
                            "return": "object",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "marketingPage": {
                        "return": {
                          "html": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "string",
                            "arguments": {}
                          },
                          "isDefault": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Award: object

type: object: Type of the recognition
return: String arguments: object
value: object: Value of the recognition
return: String arguments: object

Example

{
  "type": {
    "return": "string",
    "arguments": {}
  },
  "value": {
    "return": "string",
    "arguments": {}
  }
}

BannerMessage: object

Represents information about a Banner Message.

body: object: The body for the BannerMessage.
return: String arguments: object
contentPackage: object: ContentPackage of the BannerMessage.
return: ContentPackage arguments: object
contentPackageId: object: ID of the Content Package where the BannerMessage should show in webapp.
return: ID arguments: object
createdAt: object: Creation date of the BannerMessage.
return: ISO8601DateTime arguments: object
destinations: object: Applications the message was sent to.
return: DestinationTypeEnum arguments: object
endDate: object: The end date for the BannerMessage.
return: ISO8601DateTime arguments: object
eventTrigger: object: The EventTrigger that subscribes to events for an automated BannerMessage delivery.
return: EventTrigger arguments: object
id: object: ID of the BannerMessage.
return: ID arguments: object
name: object: The name of the BannerMessage.
return: String arguments: object
startDate: object: The start date for the BannerMessage.
return: ISO8601DateTime arguments: object
state: object: The activation state of the BannerMessage.
return: StateTypeEnum arguments: object
userSegment: object: The UserSegment specifying to which users this BannerMessage will be delivered.
return: UserSegment arguments: object

Example

{
  "body": {
    "return": "string",
    "arguments": {}
  },
  "contentPackage": {
    "return": {
      "bannerImageUrl": {
        "return": "string",
        "arguments": {}
      },
      "collaboratorEmails": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "courseType": {
        "return": "string",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "enrollmentsCount": {
        "return": "number",
        "arguments": {}
      },
      "featureAccesses": {
        "return": [
          {
            "allowed": {
              "return": "boolean",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "featureConfiguration": {
              "return": {
                "configuration": {
                  "return": "object",
                  "arguments": {}
                },
                "configurationTypesJson": {
                  "return": "object",
                  "arguments": {}
                },
                "controllableId": {
                  "return": "string",
                  "arguments": {}
                },
                "controllableType": {
                  "return": "string",
                  "arguments": {}
                },
                "featureId": {
                  "return": "string",
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "group": {
              "return": "string",
              "arguments": {}
            },
            "manageable": {
              "return": "boolean",
              "arguments": {}
            },
            "managedByControllableTypes": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            },
            "summary": {
              "return": "string",
              "arguments": {}
            },
            "title": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "features": {
        "return": "object",
        "arguments": {}
      },
      "graderCategories": {}
    }
  }
}

BannerMessageConnection: object

The connection type for BannerMessage.

edges: object: A list of edges.
return: BannerMessageEdge arguments: object
nodes: object: A list of nodes.
return: BannerMessage arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "body": {
              "return": "string",
              "arguments": {}
            },
            "contentPackage": {
              "return": {
                "bannerImageUrl": {
                  "return": "string",
                  "arguments": {}
                },
                "collaboratorEmails": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "courseType": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "enrollmentsCount": {
                  "return": "number",
                  "arguments": {}
                },
                "featureAccesses": {
                  "return": [
                    {
                      "allowed": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "featureConfiguration": {
                        "return": {
                          "configuration": {
                            "return": "object",
                            "arguments": {}
                          },
                          "configurationTypesJson": {
                            "return": "object",
                            "arguments": {}
                          },
                          "controllableId": {
                            "return": "string",
                            "arguments": {}
                          },
                          "controllableType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "featureId": {
                            "return": "string",
                            "arguments": {}
                          },
                          "slug": {
                            "return": "string",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "group": {
                        "return": "string",
                        "arguments": {}
                      },
                      "manageable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "managedByControllableTypes": {
                        "return": [
                          "string"
                        ],
                        "arguments": {}
                      },
                      "slug": {
                        "return": "string",
                        "arguments": {}
                      },
                      "summary": {
                        "return": "string"
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}

BannerMessageCreateInput: object

name: String
body: String
startDate: ISO8601DateTime
endDate: ISO8601DateTime
destinations: DestinationTypeEnum
contentPackageId: ID
userSegment: UserSegmentCreateInput
eventTrigger: EventTriggerCreateInput

Example

{
  "name": "string",
  "body": "string",
  "startDate": "object",
  "endDate": "object",
  "destinations": [
    "string"
  ],
  "contentPackageId": "string",
  "userSegment": {
    "components": [
      {
        "componentId": "string",
        "componentType": "string",
        "accessContextId": "string",
        "accessContextType": "string"
      }
    ]
  },
  "eventTrigger": {
    "eventType": "string",
    "contentLocation": "string",
    "enabled": "boolean"
  }
}

BannerMessageCreateMutationPayload: object

Autogenerated return type of BannerMessageCreateMutation

bannerMessage: object: BannerMessage resource participating in the mutation.
return: BannerMessage arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "bannerMessage": {
    "return": {
      "body": {
        "return": "string",
        "arguments": {}
      },
      "contentPackage": {
        "return": {
          "bannerImageUrl": {
            "return": "string",
            "arguments": {}
          },
          "collaboratorEmails": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "courseType": {
            "return": "string",
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "enrollmentsCount": {
            "return": "number",
            "arguments": {}
          },
          "featureAccesses": {
            "return": [
              {
                "allowed": {
                  "return": "boolean",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "featureConfiguration": {
                  "return": {
                    "configuration": {
                      "return": "object",
                      "arguments": {}
                    },
                    "configurationTypesJson": {
                      "return": "object",
                      "arguments": {}
                    },
                    "controllableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "controllableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "featureId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "slug": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "group": {
                  "return": "string",
                  "arguments": {}
                },
                "manageable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "managedByControllableTypes": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                },
                "summary": {
                  "return": "string",
                  "arguments": {}
                },
                "title": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "features": {}
        }
      }
    }
  }
}

BannerMessageDeleteInput: object

id: ID

Example

{
  "id": "string"
}

BannerMessageDeleteMutationPayload: object

Autogenerated return type of BannerMessageDeleteMutation

bannerMessage: object: BannerMessage resource participating in the mutation.
return: BannerMessage arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "bannerMessage": {
    "return": {
      "body": {
        "return": "string",
        "arguments": {}
      },
      "contentPackage": {
        "return": {
          "bannerImageUrl": {
            "return": "string",
            "arguments": {}
          },
          "collaboratorEmails": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "courseType": {
            "return": "string",
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "enrollmentsCount": {
            "return": "number",
            "arguments": {}
          },
          "featureAccesses": {
            "return": [
              {
                "allowed": {
                  "return": "boolean",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "featureConfiguration": {
                  "return": {
                    "configuration": {
                      "return": "object",
                      "arguments": {}
                    },
                    "configurationTypesJson": {
                      "return": "object",
                      "arguments": {}
                    },
                    "controllableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "controllableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "featureId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "slug": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "group": {
                  "return": "string",
                  "arguments": {}
                },
                "manageable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "managedByControllableTypes": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                },
                "summary": {
                  "return": "string",
                  "arguments": {}
                },
                "title": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "features": {}
        }
      }
    }
  }
}

BannerMessageEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: BannerMessage arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "body": {
        "return": "string",
        "arguments": {}
      },
      "contentPackage": {
        "return": {
          "bannerImageUrl": {
            "return": "string",
            "arguments": {}
          },
          "collaboratorEmails": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "courseType": {
            "return": "string",
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "enrollmentsCount": {
            "return": "number",
            "arguments": {}
          },
          "featureAccesses": {
            "return": [
              {
                "allowed": {
                  "return": "boolean",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "featureConfiguration": {
                  "return": {
                    "configuration": {
                      "return": "object",
                      "arguments": {}
                    },
                    "configurationTypesJson": {
                      "return": "object",
                      "arguments": {}
                    },
                    "controllableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "controllableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "featureId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "slug": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "group": {
                  "return": "string",
                  "arguments": {}
                },
                "manageable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "managedByControllableTypes": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                },
                "summary": {
                  "return": "string",
                  "arguments": {}
                },
                "title": {
                  "return": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}

BannerMessageFilter: object

Input fields for BannerMessage search

ids: ID: Search by IDs
query: String: Smart search by ID, Body and Name
state: StateTypeEnum: Filter banner messages by state
destination: DestinationTypeEnum: Filter banner messages by destination

Example

{
  "ids": [
    "string"
  ],
  "query": "string",
  "state": "string",
  "destination": "string"
}

BannerMessageSortAttributes: string

object id: Sort by ID
object name: Sort by Name
object start_date: Sort by Start Date
object end_date: Sort by End Date
object created_at: Sort by Created At
object state: Sort by State

Example

{
  "order": "string",
  "by": "string"
}

BannerMessageUpdateInput: object

id: ID
name: String
body: String
destinations: DestinationTypeEnum
contentPackageId: ID
startDate: ISO8601DateTime
endDate: ISO8601DateTime
eventTrigger: EventTriggerCreateInput

Example

{
  "id": "string",
  "name": "string",
  "body": "string",
  "destinations": [
    "string"
  ],
  "contentPackageId": "string",
  "startDate": "object",
  "endDate": "object",
  "eventTrigger": {
    "eventType": "string",
    "contentLocation": "string",
    "enabled": "boolean"
  }
}

BannerMessageUpdateMutationPayload: object

Autogenerated return type of BannerMessageUpdateMutation

bannerMessage: object: BannerMessage resource participating in the mutation.
return: BannerMessage arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "bannerMessage": {
    "return": {
      "body": {
        "return": "string",
        "arguments": {}
      },
      "contentPackage": {
        "return": {
          "bannerImageUrl": {
            "return": "string",
            "arguments": {}
          },
          "collaboratorEmails": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "courseType": {
            "return": "string",
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "enrollmentsCount": {
            "return": "number",
            "arguments": {}
          },
          "featureAccesses": {
            "return": [
              {
                "allowed": {
                  "return": "boolean",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "featureConfiguration": {
                  "return": {
                    "configuration": {
                      "return": "object",
                      "arguments": {}
                    },
                    "configurationTypesJson": {
                      "return": "object",
                      "arguments": {}
                    },
                    "controllableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "controllableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "featureId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "slug": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "group": {
                  "return": "string",
                  "arguments": {}
                },
                "manageable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "managedByControllableTypes": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                },
                "summary": {
                  "return": "string",
                  "arguments": {}
                },
                "title": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "features": {}
        }
      }
    }
  }
}

BasePlanInterface: object

Represents agreement on what a BasePlan must have

activatedLicenseCount: object: Number of associated licenses that were activated
return: Int arguments: object
activeLicenseCount: object: Number of licenses that have learner activity
return: Int arguments: object
availableSeatCount: object: Number of seats available to be used
return: Int arguments: object
duration: object: Duration of the BasePlanInterface
return: Int arguments: object
durationUnit: object: Duration units
return: String arguments: object
externalId: object: External ID of BasePlanInterface
return: String arguments: object
finalAccessDate: object: Final date when all learner access gets cut off
return: ISO8601Date arguments: object
finalAdminAccessDate: object: Final date when all admin access gets cut off
return: ISO8601Date arguments: object
firstActivationDate: object: First date when a learner can activate their access
return: ISO8601Date arguments: object
id: object: ID of the BasePlanInterface
return: ID arguments: object
lastActivationDate: object: Last date when a learner can activate their access
return: ISO8601Date arguments: object
licenseCount: object: Number of associated licenses
return: Int arguments: object
name: object: Name of the BasePlanInterface.
return: String arguments: object
seatCount: object: Number of seats
return: Int arguments: object
seatCountType: object: Type of the seating
return: String arguments: object
usedSeatCount: object: Number of seats used
return: Int arguments: object
validFrom: object: Date from which BasePlanInterface is valid
return: ISO8601Date arguments: object
validTo: object: Date until which BasePlanInterface is valid
return: ISO8601Date arguments: object

Example

{
  "activatedLicenseCount": {
    "return": "number",
    "arguments": {}
  },
  "activeLicenseCount": {
    "return": "number",
    "arguments": {}
  },
  "availableSeatCount": {
    "return": "number",
    "arguments": {}
  },
  "duration": {
    "return": "number",
    "arguments": {}
  },
  "durationUnit": {
    "return": "string",
    "arguments": {}
  },
  "externalId": {
    "return": "string",
    "arguments": {}
  },
  "finalAccessDate": {
    "return": "object",
    "arguments": {}
  },
  "finalAdminAccessDate": {
    "return": "object",
    "arguments": {}
  },
  "firstActivationDate": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "lastActivationDate": {
    "return": "object",
    "arguments": {}
  },
  "licenseCount": {
    "return": "number",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "seatCount": {
    "return": "number",
    "arguments": {}
  },
  "seatCountType": {
    "return": "string",
    "arguments": {}
  },
  "usedSeatCount": {
    "return": "number",
    "arguments": {}
  },
  "validFrom": {
    "return": "object",
    "arguments": {}
  },
  "validTo": {
    "return": "object",
    "arguments": {}
  }
}

Boolean: boolean

Represents true or false values.

Example

boolean

Branch: object

Represents information for branches for a tenant.

appliedBranding: object: The Branding applied to Users in this Branch. This may fall back to a Branch ancestor's Branding or Tenant's Branding if this Branch's branding is null.
return: Branding arguments: object
branding: object: The Branding record associated to the Branch.
return: Branding arguments: object
createdAt: object: Timestamp when the Branch was created.
return: ISO8601DateTime arguments: object
deletionGuard: object: Indicates why the Branch cannot be deleted if it cannot be deleted. If the Branch can be deleted, then this field returns null.
return: BranchDeletionGuardErrorEnum arguments: object
externalId: object: External ID of the Branch.
return: String arguments: object
featureAccesses: object: List of current BranchFeatureAccesss for the branch.
return: FeatureAccess arguments: object
id: object: ID of the Branch.
return: ID arguments: object
isParent: object: Indicates if the Branch is a parent to other Branches.
return: Boolean arguments: object
isSynced: object: Indicates if the Branch is associated with a legacy B2B hierarchy.
return: Boolean arguments: object
legacyHierarchyNodeId: object: ID of the legacy B2B hierarchy node.
return: ID arguments: object
legacyHierarchyNodeType: object: Type of the legacy B2B hierarchy node.
return: LegacyHierarchyNodeEnum arguments: object
loginUrl: object: Login URL with Branch branding.
return: String arguments: object
name: object: Name of the Branch.
return: String arguments: object
parentBranchId: object: ID of the Branch of the parent.
return: ID arguments: object
slug: object: A unique slug used to generate URLs specific to the Branch
return: String arguments: object
voucherRedemptionUrl: object: URL for Voucher redemption with Branch specific branding and membership behavior.
return: String arguments: object

Example

{
  "appliedBranding": {
    "return": {
      "brandableId": {
        "return": "string",
        "arguments": {}
      },
      "brandableType": {
        "return": "string",
        "arguments": {}
      },
      "colorLogoUrl": {
        "return": "string",
        "arguments": {}
      },
      "emailLogoUrl": {
        "return": "string",
        "arguments": {}
      },
      "faviconUrl": {
        "return": "string",
        "arguments": {}
      },
      "footer": {
        "return": {
          "html": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "isDefault": {
            "return": "boolean",
            "arguments": {}
          },
          "variables": {
            "return": "object",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "marketingPage": {
        "return": {
          "html": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "isDefault": {
            "return": "boolean",
            "arguments": {}
          },
          "variables": {
            "return": "object",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "mobileIconUrl": {
        "return": "string",
        "arguments": {}
      },
      "primaryColor": {
        "return": "string",
        "arguments": {}
      },
      "secondaryColor": {
        "return": "string",
        "arguments": {}
      },
      "whiteLogoUrl": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "branding": {
    "return": {
      "brandableId": {
        "return": "string",
        "arguments": {}
      },
      "brandableType": {
        "return": "string",
        "arguments": {}
      },
      "colorLogoUrl": {
        "return": "string",
        "arguments": {}
      }
    }
  }
}

BranchAssignUsersInput: object

branchId: ID
userIds: ID

Example

{
  "branchId": "string",
  "userIds": [
    "string"
  ]
}

BranchAssignUsersMutationPayload: object

Autogenerated return type of BranchAssignUsersMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
results: object: Contains Array of User resources participating in the mutation.
return: BranchAssignUsersResult arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "results": {
    "return": [
      {
        "errors": {
          "return": [
            {
              "message": {
                "return": "string",
                "arguments": {}
              },
              "path": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "success": {
          "return": "boolean",
          "arguments": {}
        },
        "user": {
          "return": {
            "authenticationProvider": {
              "return": "string",
              "arguments": {}
            },
            "branch": {
              "return": {
                "appliedBranding": {
                  "return": {
                    "brandableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "brandableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "colorLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "emailLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "footer": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "marketingPage": {}
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

BranchAssignUsersResult: object

errors: object: Array of RecordError errors from the service response.
return: RecordError arguments: object
success: object: Indicates successfull service response.
return: Boolean arguments: object
user: object: User resource response for the mutation.
return: User arguments: object

Example

{
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "user": {
    "return": {
      "authenticationProvider": {
        "return": "string",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

BranchConnection: object

The connection type for Branch.

edges: object: A list of edges.
return: BranchEdge arguments: object
nodes: object: A list of nodes.
return: Branch arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "appliedBranding": {
              "return": {
                "brandableId": {
                  "return": "string",
                  "arguments": {}
                },
                "brandableType": {
                  "return": "string",
                  "arguments": {}
                },
                "colorLogoUrl": {
                  "return": "string",
                  "arguments": {}
                },
                "emailLogoUrl": {
                  "return": "string",
                  "arguments": {}
                },
                "faviconUrl": {
                  "return": "string",
                  "arguments": {}
                },
                "footer": {
                  "return": {
                    "html": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "isDefault": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "variables": {
                      "return": "object",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "marketingPage": {
                  "return": {
                    "html": {
                      "return": "string",
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "isDefault": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "variables": {
                      "return": "object",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "mobileIconUrl": {
                  "return": "string",
                  "arguments": {}
                },
                "primaryColor": {
                  "return": "string",
                  "arguments": {}
                },
                "secondaryColor": {
                  "return": "string",
                  "arguments": {}
                },
                "whiteLogoUrl": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "branding": {
              "return": {
                "brandableId": {}
              }
            }
          }
        }
      }
    ]
  }
}

BranchCreateInput: object

name: String
externalId: String
parentBranchId: ID

Example

{
  "name": "string",
  "externalId": "string",
  "parentBranchId": "string"
}

BranchCreateMutationPayload: object

Autogenerated return type of BranchCreateMutation

branch: object: Branch resource participating in the mutation.
return: Branch arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "branch": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "marketingPage": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "mobileIconUrl": {
            "return": "string",
            "arguments": {}
          },
          "primaryColor": {
            "return": "string",
            "arguments": {}
          },
          "secondaryColor": {
            "return": "string",
            "arguments": {}
          },
          "whiteLogoUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "branding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {}
        }
      }
    }
  }
}

BranchDeleteInput: object

id: ID

Example

{
  "id": "string"
}

BranchDeleteMutationPayload: object

Autogenerated return type of BranchDeleteMutation

branch: object: Branch resource participating in the mutation.
return: Branch arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "branch": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "marketingPage": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "mobileIconUrl": {
            "return": "string",
            "arguments": {}
          },
          "primaryColor": {
            "return": "string",
            "arguments": {}
          },
          "secondaryColor": {
            "return": "string",
            "arguments": {}
          },
          "whiteLogoUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "branding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {}
        }
      }
    }
  }
}

BranchDeletionGuardErrorEnum: string

object contains_branch_plan: This Branch or one of its descendants has an associated BranchPlan. This Branch cannot be deleted.
object contains_group: This Branch or one of its descendants has an associated Group. This Branch cannot be deleted.

BranchEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Branch arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "marketingPage": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "mobileIconUrl": {
            "return": "string",
            "arguments": {}
          },
          "primaryColor": {
            "return": "string",
            "arguments": {}
          },
          "secondaryColor": {
            "return": "string",
            "arguments": {}
          },
          "whiteLogoUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "branding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {}
        }
      }
    }
  }
}

BranchFilter: object

Input fields for branch search

ids: ID: Search by IDs
parentBranchId: ID: Search by parent branch ID
rootOnly: Boolean: Search only for branches that do not have a parent
excludedBranchId: ID: Exclude branch that matches ID and all its descendant branches
treeByBranchId: ID: Search branch that matches ID and all its descendant branches
treeByBranchIdExcludingSelf: ID: Search all descendant branches, excluding branch with ID from results
canHaveChildren: Boolean: Return Branches with depth less than 10.
query: String: Smart search by ID, Name and External ID
ancestorsByBranchId: ID: Search branch that matches ID and its ancestors

Example

{
  "ids": [
    "string"
  ],
  "parentBranchId": "string",
  "rootOnly": "boolean",
  "excludedBranchId": "string",
  "treeByBranchId": "string",
  "treeByBranchIdExcludingSelf": "string",
  "canHaveChildren": "boolean",
  "query": "string",
  "ancestorsByBranchId": "string"
}

BranchPlan: object

Represents information about a contract of a Branch.

activatedLicenseCount: object: Number of associated licenses that were activated
return: Int arguments: object
activeLicenseCount: object: Number of licenses that have learner activity
return: Int arguments: object
availableSeatCount: object: Number of seats available to be used
return: Int arguments: object
branch: object: Branch (resolver) associated with the BranchPlan.
return: Branch arguments: object
branchId: object: ID of the associated Branch
return: ID arguments: object
concurrentUserLimit: object: Number of users concurrently allowed to access the platform.
return: Int arguments: object
contentPackages: object: List of ContentPackages (resolver) permitted by the BranchPlan.
return: ContentPackage arguments: object
duration: object: Duration of the BasePlanInterface
return: Int arguments: object
durationUnit: object: Duration units
return: String arguments: object
enableInBrowse: object: Indicates if the associated resources are browsable in Learning Hub
return: Boolean arguments: object
externalId: object: External ID of BasePlanInterface
return: String arguments: object
finalAccessDate: object: Final date when all learner access gets cut off
return: ISO8601Date arguments: object
finalAdminAccessDate: object: Final date when all admin access gets cut off
return: ISO8601Date arguments: object
firstActivationDate: object: First date when a learner can activate their access
return: ISO8601Date arguments: object
id: object: ID of the BasePlanInterface
return: ID arguments: object
isSynced: object: Indicates if the BranchPlan is associated with a legacy InstitutionContract.
return: Boolean arguments: object
lastActivationDate: object: Last date when a learner can activate their access
return: ISO8601Date arguments: object
licenseCount: object: Number of associated licenses
return: Int arguments: object
name: object: Name of the BasePlanInterface.
return: String arguments: object
seatCount: object: Number of seats
return: Int arguments: object
seatCountType: object: Type of the seating
return: String arguments: object
status: object: Status of the BranchPlan
return: StatusEnum arguments: object
usedSeatCount: object: Number of seats used
return: Int arguments: object
validFrom: object: Date from which BasePlanInterface is valid
return: ISO8601Date arguments: object
validTo: object: Date until which BasePlanInterface is valid
return: ISO8601Date arguments: object

Example

{
  "activatedLicenseCount": {
    "return": "number",
    "arguments": {}
  },
  "activeLicenseCount": {
    "return": "number",
    "arguments": {}
  },
  "availableSeatCount": {
    "return": "number",
    "arguments": {}
  },
  "branch": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "marketingPage": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "mobileIconUrl": {
            "return": "string",
            "arguments": {}
          },
          "primaryColor": {
            "return": "string",
            "arguments": {}
          },
          "secondaryColor": {
            "return": "string",
            "arguments": {}
          },
          "whiteLogoUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    }
  }
}

BranchPlanConnection: object

The connection type for BranchPlan.

edges: object: A list of edges.
return: BranchPlanEdge arguments: object
nodes: object: A list of nodes.
return: BranchPlan arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "activatedLicenseCount": {
              "return": "number",
              "arguments": {}
            },
            "activeLicenseCount": {
              "return": "number",
              "arguments": {}
            },
            "availableSeatCount": {
              "return": "number",
              "arguments": {}
            },
            "branch": {
              "return": {
                "appliedBranding": {
                  "return": {
                    "brandableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "brandableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "colorLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "emailLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "footer": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "marketingPage": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "mobileIconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "primaryColor": {}
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

BranchPlanCreateInput: object

name: String
externalId: String
branchId: ID
validFrom: ISO8601Date
validTo: ISO8601Date
duration: String
seatCountType: SeatCountTypeEnum
firstActivationDate: ISO8601Date
lastActivationDate: ISO8601Date
finalAccessDate: ISO8601Date
finalAdminAccessDate: ISO8601Date
seatCount: Int
concurrentUserLimit: Int
enableInBrowse: Boolean
contentPackageIds: ID

Example

{
  "name": "string",
  "externalId": "string",
  "branchId": "string",
  "validFrom": "object",
  "validTo": "object",
  "duration": "string",
  "seatCountType": "string",
  "firstActivationDate": "object",
  "lastActivationDate": "object",
  "finalAccessDate": "object",
  "finalAdminAccessDate": "object",
  "seatCount": "number",
  "concurrentUserLimit": "number",
  "enableInBrowse": "boolean",
  "contentPackageIds": [
    "string"
  ]
}

BranchPlanCreateMutationPayload: object

Autogenerated return type of BranchPlanCreateMutation

branchPlan: object: Resource participating in the mutation.
return: BranchPlan arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "branchPlan": {
    "return": {
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {
                "return": "string",
                "arguments": {}
              },
              "whiteLogoUrl": {}
            }
          }
        }
      }
    }
  }
}

BranchPlanEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: BranchPlan arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {}
            }
          }
        }
      }
    }
  }
}

BranchPlanFilter: object

Input fields for branch plans search

ids: ID: Search by IDs
query: String: Search by name
branchId: ID: Search by Branch ID

Example

{
  "ids": [
    "string"
  ],
  "query": "string",
  "branchId": "string"
}

BranchPlanSortAttributes: string

object activated_license_count: Sort by activated license count
object external_id: Sort by external ID
object id: Sort by ID
object license_count: Sort by license count
object name: Sort by name
object seat_count: Sort by seat count
object status: Sort by status
object used_seat_count: Sort by used seat count
object valid_from: Sort by valid from
object valid_to: Sort by valid to

BranchPlanSortOrderFilter: object

order: SortOrder
by: BranchPlanSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

BranchPlanUpdateCoursesInput: object

id: ID
contentPackageIdsToAdd: ID
contentPackageIdsToRemove: ID

Example

{
  "id": "string",
  "contentPackageIdsToAdd": [
    "string"
  ],
  "contentPackageIdsToRemove": [
    "string"
  ]
}

BranchPlanUpdateCoursesMutationPayload: object

Autogenerated return type of BranchPlanUpdateCoursesMutation

branchPlan: object: Resource participating in the mutation.
return: BranchPlan arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "branchPlan": {
    "return": {
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {
                "return": "string",
                "arguments": {}
              },
              "whiteLogoUrl": {}
            }
          }
        }
      }
    }
  }
}

BranchPlanUpdateInput: object

id: ID
name: String
externalId: String
enableInBrowse: Boolean
validFrom: ISO8601Date
validTo: ISO8601Date
duration: Int
seatCountType: SeatCountTypeEnum
firstActivationDate: ISO8601Date
lastActivationDate: ISO8601Date
finalAccessDate: ISO8601Date
finalAdminAccessDate: ISO8601Date
seatCount: Int
concurrentUserLimit: Int
durationUnit: String

Example

{
  "id": "string",
  "name": "string",
  "externalId": "string",
  "enableInBrowse": "boolean",
  "validFrom": "object",
  "validTo": "object",
  "duration": "number",
  "seatCountType": "string",
  "firstActivationDate": "object",
  "lastActivationDate": "object",
  "finalAccessDate": "object",
  "finalAdminAccessDate": "object",
  "seatCount": "number",
  "concurrentUserLimit": "number",
  "durationUnit": "string"
}

BranchPlanUpdateMutationPayload: object

Autogenerated return type of BranchPlanUpdateMutation

branchPlan: object: Resource participating in the mutation.
return: BranchPlan arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "branchPlan": {
    "return": {
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {
                "return": "string",
                "arguments": {}
              },
              "whiteLogoUrl": {}
            }
          }
        }
      }
    }
  }
}

BranchSortAttributes: string

object id: Sort by ID

BranchSortOrderFilter: object

order: SortOrder
by: BranchSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

BranchUpdateInput: object

id: ID
name: String
externalId: String
slug: String

Example

{
  "id": "string",
  "name": "string",
  "externalId": "string",
  "slug": "string"
}

BranchUpdateMutationPayload: object

Autogenerated return type of BranchUpdateMutation

branch: object: Branch resource participating in the mutation.
return: Branch arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "branch": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "marketingPage": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "mobileIconUrl": {
            "return": "string",
            "arguments": {}
          },
          "primaryColor": {
            "return": "string",
            "arguments": {}
          },
          "secondaryColor": {
            "return": "string",
            "arguments": {}
          },
          "whiteLogoUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "branding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {}
        }
      }
    }
  }
}

Branding: object

Represents information for how a brandable resource is branded.

brandableId: object: The ID of the Brandable that the branding is associated with
return: ID arguments: object
brandableType: object: The type of the Brandable (eg. Tenant, Branch or Group) that the branding is associated with
return: String arguments: object
colorLogoUrl: object: The URL for the color logo.
return: String arguments: object
emailLogoUrl: object: The URL for the email logo.
return: String arguments: object
faviconUrl: object: The URL for the favicon.
return: String arguments: object
footer: object: Footer of the Branding using PageComponentType.
return: PageComponent arguments: object
id: object: ID of the Branding.
return: ID arguments: object
marketingPage: object: Marketing page of the Branding using PageComponentType.
return: PageComponent arguments: object
mobileIconUrl: object: The URL for the mobile icon.
return: String arguments: object
primaryColor: object: Primary color of the Branding.
return: String arguments: object
secondaryColor: object: Secondary color of the Branding.
return: String arguments: object
whiteLogoUrl: object: The URL for the white logo.
return: String arguments: object

Example

{
  "brandableId": {
    "return": "string",
    "arguments": {}
  },
  "brandableType": {
    "return": "string",
    "arguments": {}
  },
  "colorLogoUrl": {
    "return": "string",
    "arguments": {}
  },
  "emailLogoUrl": {
    "return": "string",
    "arguments": {}
  },
  "faviconUrl": {
    "return": "string",
    "arguments": {}
  },
  "footer": {
    "return": {
      "html": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "isDefault": {
        "return": "boolean",
        "arguments": {}
      },
      "variables": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "marketingPage": {
    "return": {
      "html": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "isDefault": {
        "return": "boolean",
        "arguments": {}
      },
      "variables": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "mobileIconUrl": {
    "return": "string",
    "arguments": {}
  },
  "primaryColor": {
    "return": "string",
    "arguments": {}
  },
  "secondaryColor": {
    "return": "string",
    "arguments": {}
  },
  "whiteLogoUrl": {
    "return": "string",
    "arguments": {}
  }
}

BrandingDeleteInput: object

brandableId: ID
brandableType: String

Example

{
  "brandableId": "string",
  "brandableType": "string"
}

CategorizableTypeEnum: string

object ContentPackage
object ExternalPackage

Certificate: object

Represents information about a certificate

id: object: ID of the Certificate.
return: ID arguments: object
name: object: Name of the Certificate.
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  }
}

CertificateConnection: object

The connection type for Certificate.

edges: object: A list of edges.
return: CertificateEdge arguments: object
nodes: object: A list of nodes.
return: Certificate arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

CertificateEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Certificate arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

CertificateFilter: object

Input fields for certificate search

ids: ID: Search by IDs
contentPackageId: ID: Search by content package ID

Example

{
  "ids": [
    "string"
  ],
  "contentPackageId": "string"
}

CertificateSortAttributes: string

object id: Sort by ID
object name: Sort by name

CertificateSortOrderFilter: object

order: SortOrder
by: CertificateSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

Client: object

Represents information about a client for an enrollment

id: object: ID of the Client.
return: ID arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  }
}

ColorUpdateInput: object

primaryColor: String
secondaryColor: String
brandableId: ID
brandableType: String

Example

{
  "primaryColor": "string",
  "secondaryColor": "string",
  "brandableId": "string",
  "brandableType": "string"
}

ColorUpdateMutationPayload: object

Autogenerated return type of ColorUpdateMutation

branding: object: Branding resource participating in the mutation.
return: Branding arguments: object
clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "branding": {
    "return": {
      "brandableId": {
        "return": "string",
        "arguments": {}
      },
      "brandableType": {
        "return": "string",
        "arguments": {}
      },
      "colorLogoUrl": {
        "return": "string",
        "arguments": {}
      },
      "emailLogoUrl": {
        "return": "string",
        "arguments": {}
      },
      "faviconUrl": {
        "return": "string",
        "arguments": {}
      },
      "footer": {
        "return": {
          "html": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "isDefault": {
            "return": "boolean",
            "arguments": {}
          },
          "variables": {
            "return": "object",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "marketingPage": {
        "return": {
          "html": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "isDefault": {
            "return": "boolean",
            "arguments": {}
          },
          "variables": {
            "return": "object",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "mobileIconUrl": {
        "return": "string",
        "arguments": {}
      },
      "primaryColor": {
        "return": "string",
        "arguments": {}
      },
      "secondaryColor": {
        "return": "string",
        "arguments": {}
      },
      "whiteLogoUrl": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            null
          ]
        }
      }
    ]
  }
}

ContentLocation: object

Represents information about a EventTrigger content location.

id: object: ID of the content location model.
return: ID arguments: object
name: object: The name of the content location model.
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  }
}

ContentPackage: object

Represents information about a content package of the platform

bannerImageUrl: object: URL of the image to display for the ContentPackage in the catalog.
return: String arguments: object
collaboratorEmails: object: Array of the emails of collaborators of the ContentPackage.
return: String arguments: object
courseType: object: User portal ContentPackage or ascend/engage ContentPackage.
return: String arguments: object
description: object: Description of the ContentPackage.
return: String arguments: object
enrollmentsCount: object: Number of enrollments for the ContentPackage.
return: Int arguments: object
featureAccesses: object: Array of the ContentPackageFeatureAccess resources for the ContentPackage.
return: FeatureAccess arguments: object
features: object: Content count summary for the ContentPackage
return: JSON arguments: object
graderCategories: object: Array of categories used for grading assignments
return: String arguments: object
id: object: ID of the ContentPackage.
return: ID arguments: object
isRecognitionIssuing: object: Boolean indicator of whether the ContentPackage issues recognitions
return: Boolean arguments: object
lastBuildAt: object: Timestamp of the date when ContentPackage was last built.
return: ISO8601DateTime arguments: object
learnableConfiguration: object: LearnableConfiguration for the ContentPackage
return: LearnableConfiguration arguments: object
navigationItems: object: Array of NavigationItems displayed for the ContentPackage
return: NavigationItem arguments: object
reviewRating: object: Average review rating of the ContentPackage.
return: Float arguments: object
reviewRatingCount: object: Count of reviews of the ContentPackage.
return: Int arguments: object
slug: object: Slug of the ContentPackage.
return: String arguments: object
state: object: Status of the ContentPackage: published, conversion or retired.
return: String arguments: object
title: object: Title of the ContentPackage.
return: String arguments: object

Example

{
  "bannerImageUrl": {
    "return": "string",
    "arguments": {}
  },
  "collaboratorEmails": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "courseType": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "enrollmentsCount": {
    "return": "number",
    "arguments": {}
  },
  "featureAccesses": {
    "return": [
      {
        "allowed": {
          "return": "boolean",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "featureConfiguration": {
          "return": {
            "configuration": {
              "return": "object",
              "arguments": {}
            },
            "configurationTypesJson": {
              "return": "object",
              "arguments": {}
            },
            "controllableId": {
              "return": "string",
              "arguments": {}
            },
            "controllableType": {
              "return": "string",
              "arguments": {}
            },
            "featureId": {
              "return": "string",
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        },
        "group": {
          "return": "string",
          "arguments": {}
        },
        "manageable": {
          "return": "boolean",
          "arguments": {}
        },
        "managedByControllableTypes": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "slug": {
          "return": "string",
          "arguments": {}
        },
        "summary": {
          "return": "string",
          "arguments": {}
        },
        "title": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "features": {
    "return": "object",
    "arguments": {}
  },
  "graderCategories": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "id": {
    "return": "string"
  }
}

ContentPackageConnection: object

The connection type for ContentPackage.

edges: object: A list of edges.
return: ContentPackageEdge arguments: object
nodes: object: A list of nodes.
return: ContentPackage arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "bannerImageUrl": {
              "return": "string",
              "arguments": {}
            },
            "collaboratorEmails": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "courseType": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "enrollmentsCount": {
              "return": "number",
              "arguments": {}
            },
            "featureAccesses": {
              "return": [
                {
                  "allowed": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "featureConfiguration": {
                    "return": {
                      "configuration": {
                        "return": "object",
                        "arguments": {}
                      },
                      "configurationTypesJson": {
                        "return": "object",
                        "arguments": {}
                      },
                      "controllableId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "controllableType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "featureId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "slug": {
                        "return": "string",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "group": {
                    "return": "string",
                    "arguments": {}
                  },
                  "manageable": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "managedByControllableTypes": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  },
                  "slug": {
                    "return": "string",
                    "arguments": {}
                  },
                  "summary": {
                    "return": "string",
                    "arguments": {}
                  },
                  "title": {
                    "return": "string",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "features": {}
          }
        }
      }
    ]
  }
}

ContentPackageCourse: string

The content packages' course types

object asset_based_course: Asset-Based Course
object benchprep_course: BenchPrep Course

ContentPackageEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: ContentPackage arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "bannerImageUrl": {
        "return": "string",
        "arguments": {}
      },
      "collaboratorEmails": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "courseType": {
        "return": "string",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "enrollmentsCount": {
        "return": "number",
        "arguments": {}
      },
      "featureAccesses": {
        "return": [
          {
            "allowed": {
              "return": "boolean",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "featureConfiguration": {
              "return": {
                "configuration": {
                  "return": "object",
                  "arguments": {}
                },
                "configurationTypesJson": {
                  "return": "object",
                  "arguments": {}
                },
                "controllableId": {
                  "return": "string",
                  "arguments": {}
                },
                "controllableType": {
                  "return": "string",
                  "arguments": {}
                },
                "featureId": {
                  "return": "string",
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "group": {
              "return": "string",
              "arguments": {}
            },
            "manageable": {
              "return": "boolean",
              "arguments": {}
            },
            "managedByControllableTypes": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            },
            "summary": {
              "return": "string",
              "arguments": {}
            },
            "title": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "features": {
        "return": "object",
        "arguments": {}
      },
      "graderCategories": {}
    }
  }
}

ContentPackageFilter: object

Input fields for content package search

ids: ID: Search by IDs
query: String: Smart search across ID and title
state: ContentPackageState: Current state of the content package
excludedIds: ID: Exclude IDs
hasStudyPlan: Boolean: Return content packages that have study tasks
hasCertificates: Boolean: Return content packages that have certificates and 'user_certificates' feature access allowed
hasExams: Boolean: Return content packages that have exams
bank: Boolean: Return content packages that are or are not banks
hasExternalPackages: Boolean: Return content packages that are benchprep_course and have external packages
enrolledFor: Int: Return enrolled content packages for the given user ID
courseType: ContentPackageCourse: Search by Course Type
hasMilestones: Boolean: Return content packages that have milestones
isRecognitionIssuing: Boolean: Return content packages based on ability to issue recognitions or not
hasRecognitions: Boolean: Return content packages that have recognitions

Example

{
  "ids": [
    "string"
  ],
  "query": "string",
  "state": "string",
  "excludedIds": [
    "string"
  ],
  "hasStudyPlan": "boolean",
  "hasCertificates": "boolean",
  "hasExams": "boolean",
  "bank": "boolean",
  "hasExternalPackages": "boolean",
  "enrolledFor": "number",
  "courseType": "string",
  "hasMilestones": "boolean",
  "isRecognitionIssuing": "boolean",
  "hasRecognitions": "boolean"
}

ContentPackageNavigationItemsUpdateInput: object

id: ID
items: NavigationItemCreateInput

Example

{
  "id": "string",
  "items": [
    {
      "itemType": "string",
      "landingPage": "boolean",
      "sortOrder": "number",
      "visible": "boolean",
      "configuration": "object"
    }
  ]
}

ContentPackageNavigationItemsUpdateMutationPayload: object

Autogenerated return type of ContentPackageNavigationItemsUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

ContentPackageSortAttributes: string

object id: Sort by ID
object title: Sort by title
object course_type: Sort by course_type
object state: Sort by state

ContentPackageSortOrderFilter: object

order: SortOrder
by: ContentPackageSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

ContentPackageState: string

The content package's valid states

object draft: Draft content packages
object conversion: Conversion content packages
object published: Published content packages
object retired: Retired content packages

ContentPackageUpdateInput: object

id: ID

Example

{
  "id": "string"
}

ContentPackageUpdateMutationPayload: object

Autogenerated return type of ContentPackageUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

ContentType: object

Represents information about a content type

id: object: Unique identifier ID
return: ID arguments: object
label: object: The friendly identification of this content type
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "label": {
    "return": "string",
    "arguments": {}
  }
}

ContentTypeConnection: object

The connection type for ContentType.

edges: object: A list of edges.
return: ContentTypeEdge arguments: object
nodes: object: A list of nodes.
return: ContentType arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "label": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "label": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

ContentTypeEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: ContentType arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "label": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

ControllableTypesEnum: string

object Tenant: FeatureAccess can be controlled by the Tenant controllable type.
object ContentPackage: FeatureAccess can be controlled by the ContentPackage controllable type.
object Institution: FeatureAccess can be controlled by the Institution controllable type.
object District: FeatureAccess can be controlled by the District controllable type.
object AdministrativeDivision: FeatureAccess can be controlled by the AdministrativeDivision controllable type.
object Branch: FeatureAccess can be controlled by the Branch controllable type.

CurrentTenant: object

Represents information about the current tenant of the platform. No permissions are required to read information about the current tenant, as long as you are authenticated.

appliedBranding: object: The Branding applied to Users in this Tenant.
return: Branding arguments: object
featureAccesses: object: List of current TenantFeatureAccesss for the CurrentTenant.
return: FeatureAccess arguments: object filter: String
id: object: ID of the CurrentTenant.
return: ID arguments: object
name: object: Name of the CurrentTenant.
return: String arguments: object
publicUrl: object: Public URL of the CurrentTenant.
return: String arguments: object
slug: object: Slug of the CurrentTenant.
return: String arguments: object

Example

{
  "appliedBranding": {
    "return": {
      "brandableId": {
        "return": "string",
        "arguments": {}
      },
      "brandableType": {
        "return": "string",
        "arguments": {}
      },
      "colorLogoUrl": {
        "return": "string",
        "arguments": {}
      },
      "emailLogoUrl": {
        "return": "string",
        "arguments": {}
      },
      "faviconUrl": {
        "return": "string",
        "arguments": {}
      },
      "footer": {
        "return": {
          "html": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "isDefault": {
            "return": "boolean",
            "arguments": {}
          },
          "variables": {
            "return": "object",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "marketingPage": {
        "return": {
          "html": {
            "return": "string",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "isDefault": {
            "return": "boolean",
            "arguments": {}
          },
          "variables": {
            "return": "object",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "mobileIconUrl": {
        "return": "string",
        "arguments": {}
      },
      "primaryColor": {
        "return": "string",
        "arguments": {}
      },
      "secondaryColor": {
        "return": "string",
        "arguments": {}
      },
      "whiteLogoUrl": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "featureAccesses": {
    "return": [
      {
        "allowed": {
          "return": "boolean",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "featureConfiguration": {
          "return": {}
        }
      }
    ]
  }
}

CurrentUser: object

Represents information about the currently authenticated user. No permissions are required to read information about the current user, as long as you are authenticated.

createdAt: object: Timestamp when the CurrentUser was created.
return: ISO8601DateTime arguments: object
email: object: Email address of the CurrentUser.
return: String arguments: object
id: object: ID of the CurrentUser.
return: ID arguments: object
name: object: Name of the CurrentUser.
return: String arguments: object
permissionSlugs: object: A list of the CurrentUser's permission slugs.
return: String arguments: object
permissions: object: A list of Permissions of the CurrentUser's.
return: Permission arguments: object
roleSlugs: object: A list of the CurrentUser's role slugs.
return: String arguments: object
state: object: Active/inactive status of the CurrentUser's account.
return: String arguments: object
statuses: object: Various statuses associated with the CurrentUser
return: CurrentUserStatuses arguments: object
tenant: object: CurrentTenant the CurrentUser belongs to.
return: CurrentTenant arguments: object
userRoles: object: UserRoles of the CurrentUser.
return: CurrentUserUserRole arguments: object
visibleBannerMessages: object: A list of BannerMessages that are visible to the CurrentUser.
return: CurrentUserBannerMessage arguments: object filters: BannerMessageFilter

Example

{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "email": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "permissionSlugs": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "permissions": {
    "return": [
      {
        "accessContexts": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "action": {
          "return": "string",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "resource": {
          "return": "string",
          "arguments": {}
        },
        "slug": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "roleSlugs": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "state": {
    "return": "string",
    "arguments": {}
  },
  "statuses": {
    "return": {
      "csvImportLock": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "tenant": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {}
            }
          }
        }
      }
    }
  }
}

CurrentUserBannerMessage: object

Represents information about the currently authenticated User's visible BannerMessages.

body: object: The body for the BannerMessage.
return: String arguments: object
contentPackage: object: ContentPackage of the BannerMessage.
return: ContentPackage arguments: object
contentPackageId: object: ID of the Content Package where the BannerMessage should show in webapp.
return: ID arguments: object
createdAt: object: Creation date of the BannerMessage.
return: ISO8601DateTime arguments: object
destinations: object: Applications the message was sent to.
return: DestinationTypeEnum arguments: object
endDate: object: The end date for the BannerMessage.
return: ISO8601DateTime arguments: object
eventTrigger: object: The EventTrigger that subscribes to events for an automated BannerMessage delivery.
return: EventTrigger arguments: object
id: object: ID of the BannerMessage.
return: ID arguments: object
name: object: The name of the BannerMessage.
return: String arguments: object
startDate: object: The start date for the BannerMessage
return: ISO8601DateTime arguments: object
state: object: The activation state of the BannerMessage.
return: StateTypeEnum arguments: object
userSegment: object: The UserSegment specifying to which users this BannerMessage will be delivered.
return: UserSegment arguments: object

Example

{
  "body": {
    "return": "string",
    "arguments": {}
  },
  "contentPackage": {
    "return": {
      "bannerImageUrl": {
        "return": "string",
        "arguments": {}
      },
      "collaboratorEmails": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "courseType": {
        "return": "string",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "enrollmentsCount": {
        "return": "number",
        "arguments": {}
      },
      "featureAccesses": {
        "return": [
          {
            "allowed": {
              "return": "boolean",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "featureConfiguration": {
              "return": {
                "configuration": {
                  "return": "object",
                  "arguments": {}
                },
                "configurationTypesJson": {
                  "return": "object",
                  "arguments": {}
                },
                "controllableId": {
                  "return": "string",
                  "arguments": {}
                },
                "controllableType": {
                  "return": "string",
                  "arguments": {}
                },
                "featureId": {
                  "return": "string",
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "group": {
              "return": "string",
              "arguments": {}
            },
            "manageable": {
              "return": "boolean",
              "arguments": {}
            },
            "managedByControllableTypes": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            },
            "summary": {
              "return": "string",
              "arguments": {}
            },
            "title": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "features": {
        "return": "object",
        "arguments": {}
      },
      "graderCategories": {}
    }
  }
}

CurrentUserStatuses: object

Represents information about the various statuses of the currently authenticated user.

csvImportLock: object: Indicates if csv data imports are currently locked.
return: Boolean arguments: object

Example

{
  "csvImportLock": {
    "return": "boolean",
    "arguments": {}
  }
}

CurrentUserUserRole: object

Represents information about the currently authenticated User's UserRoles

accessContext: object: The AccessContext associated to the CurrentUser's UserRole
return: AccessContext arguments: object
accessContextId: object: Access context ID of the UserRole.
return: ID arguments: object
accessContextType: object: Access context type of the UserRole.
return: String arguments: object
applicableAccessContexts: object: Array of scopes to which the UserRole can be applied.
return: AccessContextEnum arguments: object
id: object: ID of the UserRole.
return: ID arguments: object
permissionSlugs: object: A list of the UserRole's permission slugs.
return: String arguments: object filter: String
properties: object: Set of configuration values for the specific user role
return: JSON arguments: object
role: object: Role (resolver) associated with UserRole.
return: Role arguments: object
roleSlug: object: Role slug of the UserRole.
return: String arguments: object
user: object: User (resolver) associated with UserRole.
return: User arguments: object
userId: object: User ID for the UserRole.
return: String arguments: object

Example

{
  "accessContext": {
    "arguments": {}
  },
  "accessContextId": {
    "return": "string",
    "arguments": {}
  },
  "accessContextType": {
    "return": "string",
    "arguments": {}
  },
  "applicableAccessContexts": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "permissionSlugs": {
    "return": [
      "string"
    ],
    "arguments": {
      "filter": [
        "string"
      ]
    }
  },
  "properties": {
    "return": "object",
    "arguments": {}
  },
  "role": {
    "return": {
      "accessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "editable": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "permissionBased": {
        "return": "boolean",
        "arguments": {}
      },
      "permissions": {
        "return": [
          {
            "accessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "action": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "resource": {
              "return": "string",
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    }
  }
}

DeleteMutationPayload: object

Autogenerated return type of DeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

DestinationTypeEnum: string

object blueprint
object boost
object console
object learning_hub
object webapp

DeveloperToken: object

active: object: Indicates if the DeveloperToken is active.
return: Boolean arguments: object
createdAt: object: Creation date of the DeveloperToken.
return: ISO8601Date arguments: object
expiresAt: object: Expiry date of the DeveloperToken.
return: ISO8601Date arguments: object
id: object: ID of the DeveloperToken.
return: ID arguments: object
name: object: Name of the DeveloperToken.
return: String arguments: object
revokedAt: object: Revocation date of the DeveloperToken.
return: ISO8601Date arguments: object
token: object: The value of the DeveloperToken. This is only available upon first generation and is not stored directly.
return: String arguments: object
user: object: User (resolver) associated with DeveloperToken.
return: User arguments: object
userId: object: User ID for the DeveloperToken.
return: ID arguments: object

Example

{
  "active": {
    "return": "boolean",
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "expiresAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "revokedAt": {
    "return": "object",
    "arguments": {}
  },
  "token": {
    "return": "string",
    "arguments": {}
  },
  "user": {
    "return": {
      "authenticationProvider": {
        "return": "string",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

DeveloperTokenConnection: object

The connection type for DeveloperToken.

edges: object: A list of edges.
return: DeveloperTokenEdge arguments: object
nodes: object: A list of nodes.
return: DeveloperToken arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "active": {
              "return": "boolean",
              "arguments": {}
            },
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "expiresAt": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "revokedAt": {
              "return": "object",
              "arguments": {}
            },
            "token": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "authenticationProvider": {
                  "return": "string",
                  "arguments": {}
                },
                "branch": {
                  "return": {
                    "appliedBranding": {
                      "return": {
                        "brandableId": {
                          "return": "string",
                          "arguments": {}
                        },
                        "brandableType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "colorLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "emailLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "footer": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "isDefault": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "variables": {
                              "return": "object",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "marketingPage": {
                          "return": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

DeveloperTokenCreateInput: object

name: String

Example

{
  "name": "string"
}

DeveloperTokenCreateMutationPayload: object

Autogenerated return type of DeveloperTokenCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
developerToken: object: DeveloperToken resource participating in the mutation.
return: DeveloperToken arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "developerToken": {
    "return": {
      "active": {
        "return": "boolean",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "expiresAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "revokedAt": {
        "return": "object",
        "arguments": {}
      },
      "token": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "authenticationProvider": {
            "return": "string",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

DeveloperTokenDeactivateInput: object

id: ID

Example

{
  "id": "string"
}

DeveloperTokenDeactivateMutationPayload: object

Autogenerated return type of DeveloperTokenDeactivateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
developerToken: object: DeveloperToken resource participating in the mutation.
return: DeveloperToken arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "developerToken": {
    "return": {
      "active": {
        "return": "boolean",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "expiresAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "revokedAt": {
        "return": "object",
        "arguments": {}
      },
      "token": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "authenticationProvider": {
            "return": "string",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

DeveloperTokenEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: DeveloperToken arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "active": {
        "return": "boolean",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "expiresAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "revokedAt": {
        "return": "object",
        "arguments": {}
      },
      "token": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "authenticationProvider": {
            "return": "string",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

DeveloperTokenSortAttributes: string

object id: Sort by ID
object active: Sort by whether the DeveloperToken is active
object created_at: Sort by createdAt
object expires_at: Sort by expiresAt
object name: Sort by name
object revoked_at: Sort by revokedAt
object user_id: Sort by User ID

DeveloperTokenSortOrderFilter: object

order: SortOrder
by: DeveloperTokenSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

DeveloperTokenUpdateInput: object

id: ID
name: String

Example

{
  "id": "string",
  "name": "string"
}

DeveloperTokenUpdateMutationPayload: object

Autogenerated return type of DeveloperTokenUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
developerToken: object: DeveloperToken resource participating in the mutation.
return: DeveloperToken arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "developerToken": {
    "return": {
      "active": {
        "return": "boolean",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "expiresAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "revokedAt": {
        "return": "object",
        "arguments": {}
      },
      "token": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "authenticationProvider": {
            "return": "string",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Domain: object

Registered masked Domain

expirationDate: object: Timestamp of the X509 Certificate not_after field.
return: ISO8601DateTime arguments: object
id: object: ID of the Domain.
return: ID arguments: object
lastUpdated: object: Timestamp of when the Domain was last updated.
return: ISO8601DateTime arguments: object
url: object: Registered URL of the Domain.
return: String arguments: object

Example

{
  "expirationDate": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "lastUpdated": {
    "return": "object",
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  }
}

DomainEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Domain arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "expirationDate": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "lastUpdated": {
        "return": "object",
        "arguments": {}
      },
      "url": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

DomainFilter: object

Input fields for domain search

ids: ID: Search by IDs

Example

{
  "ids": [
    "string"
  ]
}

DomainsConnection: object

The connection type for Domain.

edges: object: A list of edges.
return: DomainEdge arguments: object
nodes: object: A list of nodes.
return: Domain arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "expirationDate": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "lastUpdated": {
              "return": "object",
              "arguments": {}
            },
            "url": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "expirationDate": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "lastUpdated": {
          "return": "object",
          "arguments": {}
        },
        "url": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

Enrollment: object

Represents information about a user's enrollment in a course

additionalResets: object: Additional exam resets assigned for the enrollment.
return: Int arguments: object
baseExamResetLimit: object: The default number of exam resets for the enrollment.
return: Int arguments: object
clients: object: Clients (resolver) associated with the Enrollment.
return: Client arguments: object
contentPackageId: object: ID of the enrolled content package.
return: ID arguments: object
contentPackageTitle: object: Title of the enrolled content package.
return: String arguments: object
enrolledUntil: object: Timestamp of the date until which the user has access to the content package.
return: ISO8601DateTime arguments: object
examResetsAllowed: object: Indicates if the enrollment's content package allows exam resets.
return: Boolean arguments: object
id: object: ID of the Enrollment.
return: ID arguments: object
npsRating: object: Net Promoter Score provided by the user.
return: Int arguments: object
status: object: The user's current EnrollmentStatus (active/inactive) in the content package.
return: EnrollmentStatus arguments: object
user: object: User (resolver) associated with the Enrollment.
return: User arguments: object

Example

{
  "additionalResets": {
    "return": "number",
    "arguments": {}
  },
  "baseExamResetLimit": {
    "return": "number",
    "arguments": {}
  },
  "clients": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "contentPackageId": {
    "return": "string",
    "arguments": {}
  },
  "contentPackageTitle": {
    "return": "string",
    "arguments": {}
  },
  "enrolledUntil": {
    "return": "object",
    "arguments": {}
  },
  "examResetsAllowed": {
    "return": "boolean",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "npsRating": {
    "return": "number",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "user": {
    "return": {
      "authenticationProvider": {
        "return": "string",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {}
            }
          }
        }
      }
    }
  }
}

EnrollmentAssociationConnection: object

The connection type for Enrollment.

edges: object: A list of edges.
return: EnrollmentEdge arguments: object
nodes: object: A list of nodes.
return: Enrollment arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "additionalResets": {
              "return": "number",
              "arguments": {}
            },
            "baseExamResetLimit": {
              "return": "number",
              "arguments": {}
            },
            "clients": {
              "return": [
                {
                  "id": {
                    "return": "string",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "contentPackageId": {
              "return": "string",
              "arguments": {}
            },
            "contentPackageTitle": {
              "return": "string",
              "arguments": {}
            },
            "enrolledUntil": {
              "return": "object",
              "arguments": {}
            },
            "examResetsAllowed": {
              "return": "boolean",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "npsRating": {
              "return": "number",
              "arguments": {}
            },
            "status": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "authenticationProvider": {
                  "return": "string",
                  "arguments": {}
                },
                "branch": {
                  "return": {
                    "appliedBranding": {
                      "return": {
                        "brandableId": {
                          "return": "string",
                          "arguments": {}
                        },
                        "brandableType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "colorLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "emailLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "footer": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

EnrollmentConnection: object

The connection type for Enrollment.

edges: object: A list of edges.
return: EnrollmentEdge arguments: object
nodes: object: A list of nodes.
return: Enrollment arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "additionalResets": {
              "return": "number",
              "arguments": {}
            },
            "baseExamResetLimit": {
              "return": "number",
              "arguments": {}
            },
            "clients": {
              "return": [
                {
                  "id": {
                    "return": "string",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "contentPackageId": {
              "return": "string",
              "arguments": {}
            },
            "contentPackageTitle": {
              "return": "string",
              "arguments": {}
            },
            "enrolledUntil": {
              "return": "object",
              "arguments": {}
            },
            "examResetsAllowed": {
              "return": "boolean",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "npsRating": {
              "return": "number",
              "arguments": {}
            },
            "status": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "authenticationProvider": {
                  "return": "string",
                  "arguments": {}
                },
                "branch": {
                  "return": {
                    "appliedBranding": {
                      "return": {
                        "brandableId": {
                          "return": "string",
                          "arguments": {}
                        },
                        "brandableType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "colorLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "emailLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "footer": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

EnrollmentEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Enrollment arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "additionalResets": {
        "return": "number",
        "arguments": {}
      },
      "baseExamResetLimit": {
        "return": "number",
        "arguments": {}
      },
      "clients": {
        "return": [
          {
            "id": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "contentPackageId": {
        "return": "string",
        "arguments": {}
      },
      "contentPackageTitle": {
        "return": "string",
        "arguments": {}
      },
      "enrolledUntil": {
        "return": "object",
        "arguments": {}
      },
      "examResetsAllowed": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "npsRating": {
        "return": "number",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "authenticationProvider": {
            "return": "string",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

EnrollmentFilter: object

Input fields for enrollment search

ids: ID: Search by IDs
contentPackageId: String: Search by content_package_id
query: String: Smart search across ID, name, and email

Example

{
  "ids": [
    "string"
  ],
  "contentPackageId": "string",
  "query": "string"
}

EnrollmentResetMutationInput: object

Autogenerated input type of EnrollmentResetMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

EnrollmentResetMutationPayload: object

Autogenerated return type of EnrollmentResetMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
enrollment: object: Enrollment resource participating in the mutation.
return: Enrollment arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "enrollment": {
    "return": {
      "additionalResets": {
        "return": "number",
        "arguments": {}
      },
      "baseExamResetLimit": {
        "return": "number",
        "arguments": {}
      },
      "clients": {
        "return": [
          {
            "id": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "contentPackageId": {
        "return": "string",
        "arguments": {}
      },
      "contentPackageTitle": {
        "return": "string",
        "arguments": {}
      },
      "enrolledUntil": {
        "return": "object",
        "arguments": {}
      },
      "examResetsAllowed": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "npsRating": {
        "return": "number",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "authenticationProvider": {
            "return": "string",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

EnrollmentSortAttributes: string

object id: Sort by ID
object status: Sort by status
object content_package_title: Sort by content package title
object content_package_id: Sort by content package ID
object nps_rating: Sort by NPS Rating
object enrolled_until: Sort by the date until which the user is enrolled in the course
object user_id: Sort by the user ID on the enrollment
object user_sis_id: Sort by the SIS ID on the enrollment's user

EnrollmentSortOrderFilter: object

order: SortOrder
by: EnrollmentSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

EnrollmentStatus: string

object active: User has access to the course
object inactive: User does not have access to the course

EnrollmentUpdateInput: object

id: ID
additionalResets: Int

Example

{
  "id": "string",
  "additionalResets": "number"
}

EnrollmentUpdateMutationPayload: object

Autogenerated return type of EnrollmentUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
enrollment: object: Enrollment resource participating in the mutation.
return: Enrollment arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "enrollment": {
    "return": {
      "additionalResets": {
        "return": "number",
        "arguments": {}
      },
      "baseExamResetLimit": {
        "return": "number",
        "arguments": {}
      },
      "clients": {
        "return": [
          {
            "id": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "contentPackageId": {
        "return": "string",
        "arguments": {}
      },
      "contentPackageTitle": {
        "return": "string",
        "arguments": {}
      },
      "enrolledUntil": {
        "return": "object",
        "arguments": {}
      },
      "examResetsAllowed": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "npsRating": {
        "return": "number",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "authenticationProvider": {
            "return": "string",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

EventTrigger: object

contentLocation: object: The ContentLocation that matches (with wildcards) the ContentLocation on the Event.
return: String arguments: object
contentLocationModels: object: Information about content location models.
return: ContentLocation arguments: object
enabled: object: Indicates whether the EventTrigger should be handled or ignored.
return: Boolean arguments: object
eventType: object: The EventType that matches the EventType on the Event.
return: String arguments: object
userSegment: object: The UserSegment specifying to which Users EventTrigger will be filtered.
return: UserSegment arguments: object

Example

{
  "contentLocation": {
    "return": "string",
    "arguments": {}
  },
  "contentLocationModels": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "enabled": {
    "return": "boolean",
    "arguments": {}
  },
  "eventType": {
    "return": "string",
    "arguments": {}
  },
  "userSegment": {
    "return": {
      "componentTypes": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "components": {
        "return": {
          "edges": {
            "return": [
              {
                "cursor": {
                  "return": "string",
                  "arguments": {}
                },
                "node": {
                  "return": {
                    "accessContext": {
                      "arguments": {}
                    },
                    "component": {
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "nodes": {
            "return": [
              {
                "accessContext": {
                  "arguments": {}
                },
                "component": {
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "pageInfo": {
            "return": {
              "endCursor": {
                "return": "string",
                "arguments": {}
              },
              "hasNextPage": {
                "return": "boolean",
                "arguments": {}
              },
              "hasPreviousPage": {
                "return": "boolean",
                "arguments": {}
              },
              "startCursor": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "totalCount": {}
        }
      }
    }
  }
}

EventTriggerCreateInput: object

eventType: String
contentLocation: String
enabled: Boolean

Example

{
  "eventType": "string",
  "contentLocation": "string",
  "enabled": "boolean"
}

Exam: object

Represents information about an exam

contentLocation: object: Content location of the Exam.
return: String arguments: object
id: object: ID of the Exam.
return: ID arguments: object
name: object: Name of the Exam.
return: String arguments: object

Example

{
  "contentLocation": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  }
}

ExamConnection: object

The connection type for Exam.

edges: object: A list of edges.
return: ExamEdge arguments: object
nodes: object: A list of nodes.
return: Exam arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "contentLocation": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "contentLocation": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

ExamEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Exam arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "contentLocation": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

ExamFilter: object

Input fields for exam search

ids: ID: Search by IDs
contentPackageId: ID: Search by content package ID

Example

{
  "ids": [
    "string"
  ],
  "contentPackageId": "string"
}

ExamResult: object

Represents information about an ExamResult

answersCount: object: The number of attempted questions that a user answered
return: Int arguments: object
clientCreatedAt: object: Timestamp of when the user starts the exam
return: ISO8601DateTime arguments: object
completedAt: object: Timestamp of when the exam result is completed
return: ISO8601DateTime arguments: object
contentPackageId: object: ID of the ExamResult's content package
return: ID arguments: object
contentPackageTitle: object: Title of the ExamResult's content package
return: String arguments: object
deletedAt: object: Timestamp of when the exam result is reset
return: ISO8601DateTime arguments: object
examId: object: Exam ID of the ExamResult
return: ID arguments: object
examName: object: Exam name of the ExamResult
return: String arguments: object
id: object: ID of the ExamResult.
return: ID arguments: object
percentageCorrect: object: score
return: Float arguments: object
questionsCount: object: The number of questions assigned to the exam
return: Int arguments: object
state: object: The exam result's current ExamResultState (started, paused or complete)
return: ExamResultState arguments: object
userId: object: User ID of the ExamResult
return: ID arguments: object

Example

{
  "answersCount": {
    "return": "number",
    "arguments": {}
  },
  "clientCreatedAt": {
    "return": "object",
    "arguments": {}
  },
  "completedAt": {
    "return": "object",
    "arguments": {}
  },
  "contentPackageId": {
    "return": "string",
    "arguments": {}
  },
  "contentPackageTitle": {
    "return": "string",
    "arguments": {}
  },
  "deletedAt": {
    "return": "object",
    "arguments": {}
  },
  "examId": {
    "return": "string",
    "arguments": {}
  },
  "examName": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "percentageCorrect": {
    "return": "number",
    "arguments": {}
  },
  "questionsCount": {
    "return": "number",
    "arguments": {}
  },
  "state": {
    "return": "string",
    "arguments": {}
  },
  "userId": {
    "return": "string",
    "arguments": {}
  }
}

ExamResultConnection: object

The connection type for ExamResult.

edges: object: A list of edges.
return: ExamResultEdge arguments: object
nodes: object: A list of nodes.
return: ExamResult arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "answersCount": {
              "return": "number",
              "arguments": {}
            },
            "clientCreatedAt": {
              "return": "object",
              "arguments": {}
            },
            "completedAt": {
              "return": "object",
              "arguments": {}
            },
            "contentPackageId": {
              "return": "string",
              "arguments": {}
            },
            "contentPackageTitle": {
              "return": "string",
              "arguments": {}
            },
            "deletedAt": {
              "return": "object",
              "arguments": {}
            },
            "examId": {
              "return": "string",
              "arguments": {}
            },
            "examName": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "percentageCorrect": {
              "return": "number",
              "arguments": {}
            },
            "questionsCount": {
              "return": "number",
              "arguments": {}
            },
            "state": {
              "return": "string",
              "arguments": {}
            },
            "userId": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "answersCount": {
          "return": "number",
          "arguments": {}
        },
        "clientCreatedAt": {
          "return": "object",
          "arguments": {}
        },
        "completedAt": {
          "return": "object",
          "arguments": {}
        },
        "contentPackageId": {
          "return": "string",
          "arguments": {}
        },
        "contentPackageTitle": {
          "return": "string",
          "arguments": {}
        },
        "deletedAt": {
          "return": "object",
          "arguments": {}
        },
        "examId": {
          "return": "string",
          "arguments": {}
        },
        "examName": {}
      }
    ]
  }
}

ExamResultEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: ExamResult arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "answersCount": {
        "return": "number",
        "arguments": {}
      },
      "clientCreatedAt": {
        "return": "object",
        "arguments": {}
      },
      "completedAt": {
        "return": "object",
        "arguments": {}
      },
      "contentPackageId": {
        "return": "string",
        "arguments": {}
      },
      "contentPackageTitle": {
        "return": "string",
        "arguments": {}
      },
      "deletedAt": {
        "return": "object",
        "arguments": {}
      },
      "examId": {
        "return": "string",
        "arguments": {}
      },
      "examName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "percentageCorrect": {
        "return": "number",
        "arguments": {}
      },
      "questionsCount": {
        "return": "number",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "userId": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

ExamResultFilter: object

Input fields for exam result search

ids: ID: Search by IDs
userId: ID: Search by user ID
examId: ID: Search by exam ID
examName: String: Search by exam name
contentPackageId: ID: Search by content package ID
query: String: Smart search across ID, exam ID, exam name
withDeleted: Boolean: Search regardless of exam's reset state

Example

{
  "ids": [
    "string"
  ],
  "userId": [
    "string"
  ],
  "examId": "string",
  "examName": "string",
  "contentPackageId": "string",
  "query": "string",
  "withDeleted": "boolean"
}

ExamResultResetMutationInput: object

Autogenerated input type of ExamResultResetMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

ExamResultResetMutationPayload: object

Autogenerated return type of ExamResultResetMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
examResult: object: ExamResult resource participating in the mutation.
return: ExamResult arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "examResult": {
    "return": {
      "answersCount": {
        "return": "number",
        "arguments": {}
      },
      "clientCreatedAt": {
        "return": "object",
        "arguments": {}
      },
      "completedAt": {
        "return": "object",
        "arguments": {}
      },
      "contentPackageId": {
        "return": "string",
        "arguments": {}
      },
      "contentPackageTitle": {
        "return": "string",
        "arguments": {}
      },
      "deletedAt": {
        "return": "object",
        "arguments": {}
      },
      "examId": {
        "return": "string",
        "arguments": {}
      },
      "examName": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "percentageCorrect": {
        "return": "number",
        "arguments": {}
      },
      "questionsCount": {
        "return": "number",
        "arguments": {}
      },
      "state": {
        "return": "string",
        "arguments": {}
      },
      "userId": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

ExamResultSortAttributes: string

object id: Sort by ID
object exam_id: Sort by exam ID
object exam_name: Sort by exam name
object content_package_id: Sort by content package ID
object content_package_title: Sort by content package title
object state: Sort by state
object percentage_correct: Sort by score
object client_created_at: Sort by started date
object completed_at: Sort by completed date
object deleted_at: Sort by reset date

ExamResultSortOrderFilter: object

order: SortOrder
by: ExamResultSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

ExamResultState: string

object started: User started the exam
object paused: User paused the exam
object complete: User completed the exam

ExamSortAttributes: string

object id: Sort by ID
object name: Sort by name

ExamSortOrderFilter: object

order: SortOrder
by: ExamSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

ExternalPackage: object

Represents information about an external package.

bannerImageUrl: object: Image URL of the ExternalPackage.
return: String arguments: object
enrollmentsCount: object: Number of enrollments for the ExternalPackage.
return: Int arguments: object
id: object: ID of the ExternalPackage.
return: ID arguments: object
learnableConfiguration: object: LearnableConfiguration for the ExternalPackage.
return: LearnableConfiguration arguments: object
summary: object: Summary of the ExternalPackage.
return: String arguments: object
title: object: Title of the ExternalPackage.
return: String arguments: object
type: object: Record Type of the ExternalPackage.
return: String arguments: object

Example

{
  "bannerImageUrl": {
    "return": "string",
    "arguments": {}
  },
  "enrollmentsCount": {
    "return": "number",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "learnableConfiguration": {
    "return": {
      "enableDisplayRecognitions": {
        "return": "boolean",
        "arguments": {}
      },
      "enableInBrowse": {
        "return": "boolean",
        "arguments": {}
      },
      "label": {
        "return": "string",
        "arguments": {}
      },
      "learnableId": {
        "return": "string",
        "arguments": {}
      },
      "learnableType": {
        "return": "string",
        "arguments": {}
      },
      "purchaseType": {
        "return": "string",
        "arguments": {}
      },
      "purchaseUrl": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "summary": {
    "return": "string",
    "arguments": {}
  },
  "title": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

ExternalPackageConnection: object

The connection type for ExternalPackage.

edges: object: A list of edges.
return: ExternalPackageEdge arguments: object
nodes: object: A list of nodes.
return: ExternalPackage arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "bannerImageUrl": {
              "return": "string",
              "arguments": {}
            },
            "enrollmentsCount": {
              "return": "number",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "learnableConfiguration": {
              "return": {
                "enableDisplayRecognitions": {
                  "return": "boolean",
                  "arguments": {}
                },
                "enableInBrowse": {
                  "return": "boolean",
                  "arguments": {}
                },
                "label": {
                  "return": "string",
                  "arguments": {}
                },
                "learnableId": {
                  "return": "string",
                  "arguments": {}
                },
                "learnableType": {
                  "return": "string",
                  "arguments": {}
                },
                "purchaseType": {
                  "return": "string",
                  "arguments": {}
                },
                "purchaseUrl": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "summary": {
              "return": "string",
              "arguments": {}
            },
            "title": {
              "return": "string",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "bannerImageUrl": {
          "return": "string",
          "arguments": {}
        },
        "enrollmentsCount": {
          "return": "number",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "learnableConfiguration": {
          "return": {
            "enableDisplayRecognitions": {
              "return": "boolean",
              "arguments": {}
            },
            "enableInBrowse": {
              "return": "boolean",
              "arguments": {}
            },
            "label": {
              "return": "string"
            }
          }
        }
      }
    ]
  }
}

ExternalPackageEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: ExternalPackage arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "bannerImageUrl": {
        "return": "string",
        "arguments": {}
      },
      "enrollmentsCount": {
        "return": "number",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "learnableConfiguration": {
        "return": {
          "enableDisplayRecognitions": {
            "return": "boolean",
            "arguments": {}
          },
          "enableInBrowse": {
            "return": "boolean",
            "arguments": {}
          },
          "label": {
            "return": "string",
            "arguments": {}
          },
          "learnableId": {
            "return": "string",
            "arguments": {}
          },
          "learnableType": {
            "return": "string",
            "arguments": {}
          },
          "purchaseType": {
            "return": "string",
            "arguments": {}
          },
          "purchaseUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "summary": {
        "return": "string",
        "arguments": {}
      },
      "title": {
        "return": "string",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

ExternalPackageFilter: object

Input fields for external package search

ids: ID: Search by IDs
contentPackageId: String: Search by content_package_id
withoutContentPackages: Boolean: Return external packages that have no content package association
query: String: Smart search across ID and title

Example

{
  "ids": [
    "string"
  ],
  "contentPackageId": "string",
  "withoutContentPackages": "boolean",
  "query": "string"
}

ExternalPackageSortAttributes: string

object id: Sort by ID
object title: Sort by title

ExternalPackageSortOrderFilter: object

order: SortOrder
by: ExternalPackageSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

FeatureAccess: object

Represents information about a feature access

allowed: object: Indicates if FeatureAccess is on.
return: Boolean arguments: object
description: object: Description of the associated feature.
return: String arguments: object
featureConfiguration: object: FeatureConfiguration of the associated feature.
return: FeatureConfiguration arguments: object
group: object: Feature group(s) that the associated feature belongs to.
return: String arguments: object
manageable: object: Indicates if FeatureAccess is manageable.
return: Boolean arguments: object
managedByControllableTypes: object: Array of controllable types that FeatureAccess can be controlled by.
return: ControllableTypesEnum arguments: object
slug: object: Slug of the associated feature.
return: String arguments: object
summary: object: Full description of associated feature.
return: String arguments: object
title: object: Title of the associated feature.
return: String arguments: object

Example

{
  "allowed": {
    "return": "boolean",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "featureConfiguration": {
    "return": {
      "configuration": {
        "return": "object",
        "arguments": {}
      },
      "configurationTypesJson": {
        "return": "object",
        "arguments": {}
      },
      "controllableId": {
        "return": "string",
        "arguments": {}
      },
      "controllableType": {
        "return": "string",
        "arguments": {}
      },
      "featureId": {
        "return": "string",
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "group": {
    "return": "string",
    "arguments": {}
  },
  "manageable": {
    "return": "boolean",
    "arguments": {}
  },
  "managedByControllableTypes": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "slug": {
    "return": "string",
    "arguments": {}
  },
  "summary": {
    "return": "string",
    "arguments": {}
  },
  "title": {
    "return": "string",
    "arguments": {}
  }
}

FeatureAccessUpdateInput: object

slug: String
allowed: Boolean
controllableId: ID
controllableType: String

Example

{
  "slug": "string",
  "allowed": "boolean",
  "controllableId": "string",
  "controllableType": "string"
}

FeatureAccessUpdateMutationPayload: object

Autogenerated return type of FeatureAccessUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

FeatureConfiguration: object

Represents information about a feature configuration

configuration: object: Configuration of the feature configuration.
return: JSON arguments: object
configurationTypesJson: object: Configuration types of the feature configuration.
return: JSON arguments: object
controllableId: object: ID of the associated controllable.
return: ID arguments: object
controllableType: object: Type of the associated controllable.
return: String arguments: object
featureId: object: ID of the associated feature.
return: ID arguments: object
slug: object: Slug of the associated feature.
return: String arguments: object

Example

{
  "configuration": {
    "return": "object",
    "arguments": {}
  },
  "configurationTypesJson": {
    "return": "object",
    "arguments": {}
  },
  "controllableId": {
    "return": "string",
    "arguments": {}
  },
  "controllableType": {
    "return": "string",
    "arguments": {}
  },
  "featureId": {
    "return": "string",
    "arguments": {}
  },
  "slug": {
    "return": "string",
    "arguments": {}
  }
}

FeatureConfigurationUpdateInput: object

slug: String
controllableId: ID
controllableType: String
configuration: JSON

Example

{
  "slug": "string",
  "controllableId": "string",
  "controllableType": "string",
  "configuration": "object"
}

FeatureConfigurationUpdateMutationPayload: object

Autogenerated return type of FeatureConfigurationUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
featureConfiguration: object: FeatureConfiguration resource participating in the mutation.
return: FeatureConfiguration arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "featureConfiguration": {
    "return": {
      "configuration": {
        "return": "object",
        "arguments": {}
      },
      "configurationTypesJson": {
        "return": "object",
        "arguments": {}
      },
      "controllableId": {
        "return": "string",
        "arguments": {}
      },
      "controllableType": {
        "return": "string",
        "arguments": {}
      },
      "featureId": {
        "return": "string",
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

Float: number

Represents signed double-precision fractional values as specified by IEEE 754.

Example

number

FooterUpdateMutationPayload: object

Autogenerated return type of FooterUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
footer: object: Footer resource participating in the mutation.
return: PageComponent arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "footer": {
    "return": {
      "html": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "isDefault": {
        "return": "boolean",
        "arguments": {}
      },
      "variables": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

FormatterTypeEnum: string

object default
object credly

Group: object

Represents information for Groups.

branch: object: Branch (resolver) associated with the Group.
return: Branch arguments: object
branchId: object: Branch ID of the Group.
return: Int arguments: object
createdAt: object: Timestamp when the Group was created.
return: ISO8601DateTime arguments: object
description: object: Description of the Group.
return: String arguments: object
externalId: object: External ID of the Group.
return: String arguments: object
externalSystemId: object: User defined field.
return: String arguments: object
id: object: ID of the Group.
return: ID arguments: object
memberCount: object: Count of Users who are members of the Group.
return: Int arguments: object
name: object: Name of the Group.
return: String arguments: object

Example

{
  "branch": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "marketingPage": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "mobileIconUrl": {
            "return": "string",
            "arguments": {}
          },
          "primaryColor": {
            "return": "string",
            "arguments": {}
          },
          "secondaryColor": {
            "return": "string",
            "arguments": {}
          },
          "whiteLogoUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "branding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {}
        }
      }
    }
  }
}

GroupConnection: object

The connection type for Group.

edges: object: A list of edges.
return: GroupEdge arguments: object
nodes: object: A list of nodes.
return: Group arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "branch": {
              "return": {
                "appliedBranding": {
                  "return": {
                    "brandableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "brandableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "colorLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "emailLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "footer": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "marketingPage": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "mobileIconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "primaryColor": {
                      "return": "string",
                      "arguments": {}
                    },
                    "secondaryColor": {
                      "return": "string",
                      "arguments": {}
                    },
                    "whiteLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "branding": {}
              }
            }
          }
        }
      }
    ]
  }
}

GroupCreateInput: object

name: String
branchId: ID
externalId: String
description: String

Example

{
  "name": "string",
  "branchId": "string",
  "externalId": "string",
  "description": "string"
}

GroupCreateMutationPayload: object

Autogenerated return type of GroupCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
group: object: Resource participating in the mutation.
return: Group arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "group": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

GroupEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Group arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {
                "return": "string",
                "arguments": {}
              },
              "whiteLogoUrl": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "branding": {
            "return": {
              "brandableId": {}
            }
          }
        }
      }
    }
  }
}

GroupFilter: object

Input fields for Group search

ids: ID: Search by IDs
query: String: Smart search by ID, Name and External ID
branchId: ID: Search by Branch ID
memberId: ID: Search by member ID

Example

{
  "ids": [
    "string"
  ],
  "query": "string",
  "branchId": "string",
  "memberId": "string"
}

GroupMembershipUpdateInput: object

groupId: ID
userIdsToAdd: ID
userIdsToRemove: ID

Example

{
  "groupId": "string",
  "userIdsToAdd": [
    "string"
  ],
  "userIdsToRemove": [
    "string"
  ]
}

GroupMembershipUpdateMutationPayload: object

Autogenerated return type of GroupMembershipUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

GroupSortAttributes: string

object id: Sort by ID
object name: Sort by Name
object external_id: Sort by External ID
object member_count: Sort by Member Count
object created_at: Sort by Created At

GroupSortOrderFilter: object

order: SortOrder
by: GroupSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

GroupUpdateInput: object

id: ID
name: String
externalId: String
externalSystemId: String
description: String

Example

{
  "id": "string",
  "name": "string",
  "externalId": "string",
  "externalSystemId": "string",
  "description": "string"
}

GroupUpdateMutationPayload: object

Autogenerated return type of GroupUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
group: object: Resource participating in the mutation.
return: Group arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "group": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

GroupsCreateInput: object

fileName: String
dataFormat: UploadDataFormatEnum
groups: UploadGroupInput

Example

{
  "fileName": "string",
  "dataFormat": "string",
  "groups": [
    {
      "name": "string",
      "branchSlug": "string",
      "externalId": "string",
      "description": "string"
    }
  ]
}

GroupsCreateMutationPayload: object

Autogenerated return type of GroupsCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
uploadStatus: object: A message indicating the status of the upload.
return: String arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "uploadStatus": {
    "return": "string",
    "arguments": {}
  }
}

ID: string

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

ISO8601Date: object

An ISO 8601-encoded date

Example

object

ISO8601DateTime: object

An ISO 8601-encoded datetime

Example

object

Int: number

Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

number

Integration: object

Represents information about an Integration.

accountName: object: Account name for the Integration.
return: String arguments: object
clientId: object: Client ID of the Integration.
return: String arguments: object
clientSecret: object: Client Secret of the Integration.
return: String arguments: object
id: object: ID of the Integration.
return: ID arguments: object
type: object: Type of the Integration.
return: String arguments: object

Example

{
  "accountName": {
    "return": "string",
    "arguments": {}
  },
  "clientId": {
    "return": "string",
    "arguments": {}
  },
  "clientSecret": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "type": {
    "return": "string",
    "arguments": {}
  }
}

IntegrationConnection: object

The connection type for Integration.

edges: object: A list of edges.
return: IntegrationEdge arguments: object
nodes: object: A list of nodes.
return: Integration arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "accountName": {
              "return": "string",
              "arguments": {}
            },
            "clientId": {
              "return": "string",
              "arguments": {}
            },
            "clientSecret": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "type": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "accountName": {
          "return": "string",
          "arguments": {}
        },
        "clientId": {
          "return": "string",
          "arguments": {}
        },
        "clientSecret": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "type": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

IntegrationCreateInput: object

type: String
accountName: String
clientId: String
clientSecret: String

Example

{
  "type": "string",
  "accountName": "string",
  "clientId": "string",
  "clientSecret": "string"
}

IntegrationCreateMutationPayload: object

Autogenerated return type of IntegrationCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
integration: object: Integration resource participating in the mutation.
return: Integration arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "integration": {
    "return": {
      "accountName": {
        "return": "string",
        "arguments": {}
      },
      "clientId": {
        "return": "string",
        "arguments": {}
      },
      "clientSecret": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

IntegrationDeleteMutationInput: object

Autogenerated input type of IntegrationDeleteMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

IntegrationDeleteMutationPayload: object

Autogenerated return type of IntegrationDeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
integration: object: Integration resource participating in the mutation.
return: Integration arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "integration": {
    "return": {
      "accountName": {
        "return": "string",
        "arguments": {}
      },
      "clientId": {
        "return": "string",
        "arguments": {}
      },
      "clientSecret": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

IntegrationEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Integration arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "accountName": {
        "return": "string",
        "arguments": {}
      },
      "clientId": {
        "return": "string",
        "arguments": {}
      },
      "clientSecret": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

IntegrationUpdateInput: object

id: ID
accountName: String
clientId: String
clientSecret: String

Example

{
  "id": "string",
  "accountName": "string",
  "clientId": "string",
  "clientSecret": "string"
}

IntegrationUpdateMutationPayload: object

Autogenerated return type of IntegrationUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
integration: object: Integration resource participating in the mutation.
return: Integration arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "integration": {
    "return": {
      "accountName": {
        "return": "string",
        "arguments": {}
      },
      "clientId": {
        "return": "string",
        "arguments": {}
      },
      "clientSecret": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "type": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

JSON: object

Represents untyped JSON

Example

object

LearnableConfiguration: object

Represents information about a Learnable Configuration

enableDisplayRecognitions: object: Represents if the user can see recognitions on My Learning Page
return: Boolean arguments: object
enableInBrowse: object: Represents if the user can see content package on My Learning Page or Learning Hub browse page
return: Boolean arguments: object
label: object: ContentType label of the LearnableConfiguration
return: String arguments: object
learnableId: object: ID of the Learnable
return: ID arguments: object
learnableType: object: Learnable type of the LearnableConfiguration
return: String arguments: object
purchaseType: object: Purchase Type (free or paid) of the LearnableConfiguration
return: String arguments: object
purchaseUrl: object: Purchase URL when Purchase Type is paid of the LearnableConfiguration
return: String arguments: object

Example

{
  "enableDisplayRecognitions": {
    "return": "boolean",
    "arguments": {}
  },
  "enableInBrowse": {
    "return": "boolean",
    "arguments": {}
  },
  "label": {
    "return": "string",
    "arguments": {}
  },
  "learnableId": {
    "return": "string",
    "arguments": {}
  },
  "learnableType": {
    "return": "string",
    "arguments": {}
  },
  "purchaseType": {
    "return": "string",
    "arguments": {}
  },
  "purchaseUrl": {
    "return": "string",
    "arguments": {}
  }
}

LearnableConfigurationUpdateInput: object

learnableType: String
learnableId: ID
purchaseType: String
purchaseUrl: String
enableInBrowse: Boolean
enableDisplayRecognitions: Boolean
label: String

Example

{
  "learnableType": "string",
  "learnableId": "string",
  "purchaseType": "string",
  "purchaseUrl": "string",
  "enableInBrowse": "boolean",
  "enableDisplayRecognitions": "boolean",
  "label": "string"
}

LearnableConfigurationUpdateMutationPayload: object

Autogenerated return type of LearnableConfigurationUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
learnableConfiguration: object: LearnableConfiguration resource participating in the mutation.
return: LearnableConfiguration arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "learnableConfiguration": {
    "return": {
      "enableDisplayRecognitions": {
        "return": "boolean",
        "arguments": {}
      },
      "enableInBrowse": {
        "return": "boolean",
        "arguments": {}
      },
      "label": {
        "return": "string",
        "arguments": {}
      },
      "learnableId": {
        "return": "string",
        "arguments": {}
      },
      "learnableType": {
        "return": "string",
        "arguments": {}
      },
      "purchaseType": {
        "return": "string",
        "arguments": {}
      },
      "purchaseUrl": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

LearnableItem: object

Represents information about a Learnable Item.

id: object: ID of the LearnableItem.
return: ID arguments: object
resourceId: object: Resource ID of the LearnableItem.
return: String arguments: object
resourceImage: object: Resource Image URL of the LearnableItem.
return: String arguments: object
resourceSummary: object: Resource Summary of the LearnableItem.
return: String arguments: object
resourceTitle: object: Resource Title of the LearnableItem.
return: String arguments: object
resourceType: object: Resource Type of the LearnableItem.
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "resourceId": {
    "return": "string",
    "arguments": {}
  },
  "resourceImage": {
    "return": "string",
    "arguments": {}
  },
  "resourceSummary": {
    "return": "string",
    "arguments": {}
  },
  "resourceTitle": {
    "return": "string",
    "arguments": {}
  },
  "resourceType": {
    "return": "string",
    "arguments": {}
  }
}

LearnableItemAssociationConnection: object

The connection type for LearnableItem.

edges: object: A list of edges.
return: LearnableItemSectionEdge arguments: object
nodes: object: A list of nodes.
return: LearnableItem arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "resourceId": {
              "return": "string",
              "arguments": {}
            },
            "resourceImage": {
              "return": "string",
              "arguments": {}
            },
            "resourceSummary": {
              "return": "string",
              "arguments": {}
            },
            "resourceTitle": {
              "return": "string",
              "arguments": {}
            },
            "resourceType": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "resourceId": {
          "return": "string",
          "arguments": {}
        },
        "resourceImage": {
          "return": "string",
          "arguments": {}
        },
        "resourceSummary": {
          "return": "string",
          "arguments": {}
        },
        "resourceTitle": {
          "return": "string",
          "arguments": {}
        },
        "resourceType": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

LearnableItemSectionEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: LearnableItem arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "resourceId": {
        "return": "string",
        "arguments": {}
      },
      "resourceImage": {
        "return": "string",
        "arguments": {}
      },
      "resourceSummary": {
        "return": "string",
        "arguments": {}
      },
      "resourceTitle": {
        "return": "string",
        "arguments": {}
      },
      "resourceType": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

LearningHubPage: object

Represents information about a Learning Hub Page.

createdAt: object: Timestamp when the Learning Hub Page was created.
return: ISO8601DateTime arguments: object
html: object: HTML that represents the Learning Hub Page.
return: String arguments: object
id: object: ID of the Learning Hub Page.
return: ID arguments: object
name: object: Name of the Learning Hub Page.
return: String arguments: object
pageType: object: Type of the Learning Hub Page.
return: PageTypeEnum arguments: object
slug: object: Slug of the Learning Hub Page.
return: String arguments: object
sortOrder: object: Order of the Learning Hub Page.
return: Int arguments: object
tenantId: object: ID of the tenant the Learning Hub Page belongs to.
return: Int arguments: object
visible: object: Whether the Learning Hub Page is visible.
return: Boolean arguments: object

Example

{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "html": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "pageType": {
    "return": "string",
    "arguments": {}
  },
  "slug": {
    "return": "string",
    "arguments": {}
  },
  "sortOrder": {
    "return": "number",
    "arguments": {}
  },
  "tenantId": {
    "return": "number",
    "arguments": {}
  },
  "visible": {
    "return": "boolean",
    "arguments": {}
  }
}

LearningHubPageConnection: object

The connection type for LearningHubPage.

edges: object: A list of edges.
return: LearningHubPageEdge arguments: object
nodes: object: A list of nodes.
return: LearningHubPage arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "html": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "pageType": {
              "return": "string",
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            },
            "sortOrder": {
              "return": "number",
              "arguments": {}
            },
            "tenantId": {
              "return": "number",
              "arguments": {}
            },
            "visible": {
              "return": "boolean",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "html": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "pageType": {
          "return": "string",
          "arguments": {}
        },
        "slug": {
          "return": "string",
          "arguments": {}
        },
        "sortOrder": {
          "return": "number",
          "arguments": {}
        },
        "tenantId": {
          "return": "number",
          "arguments": {}
        },
        "visible": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {}
    }
  }
}

LearningHubPageCreateInput: object

name: String
pageType: PageTypeEnum
html: String

Example

{
  "name": "string",
  "pageType": "string",
  "html": "string"
}

LearningHubPageCreateMutationPayload: object

Autogenerated return type of LearningHubPageCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
learningHubPage: object: Resource participating in the mutation.
return: LearningHubPage arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "learningHubPage": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "html": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "pageType": {
        "return": "string",
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "sortOrder": {
        "return": "number",
        "arguments": {}
      },
      "tenantId": {
        "return": "number",
        "arguments": {}
      },
      "visible": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

LearningHubPageDeleteInput: object

id: ID

Example

{
  "id": "string"
}

LearningHubPageDeleteMutationPayload: object

Autogenerated return type of LearningHubPageDeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
learningHubPage: object: LearningHubPage resource participating in the mutation.
return: LearningHubPage arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "learningHubPage": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "html": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "pageType": {
        "return": "string",
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "sortOrder": {
        "return": "number",
        "arguments": {}
      },
      "tenantId": {
        "return": "number",
        "arguments": {}
      },
      "visible": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

LearningHubPageEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: LearningHubPage arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "html": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "pageType": {
        "return": "string",
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "sortOrder": {
        "return": "number",
        "arguments": {}
      },
      "tenantId": {
        "return": "number",
        "arguments": {}
      },
      "visible": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

LearningHubPageFilter: object

Input fields for learning hub page search

ids: ID: Search by IDs

Example

{
  "ids": [
    "string"
  ]
}

LearningHubPageSortAttributes: string

object sort_order: Sort by sort order

LearningHubPageSortOrderFilter: object

order: SortOrder
by: LearningHubPageSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

LearningHubPageUpdateInput: object

id: ID
html: String
name: String
visible: Boolean
sortOrder: Int

Example

{
  "id": "string",
  "html": "string",
  "name": "string",
  "visible": "boolean",
  "sortOrder": "number"
}

LearningHubPageUpdateMutationPayload: object

Autogenerated return type of LearningHubPageUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
learningHubPage: object: LearningHubPage resource to update in the mutation.
return: LearningHubPage arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "learningHubPage": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "html": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "pageType": {
        "return": "string",
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "sortOrder": {
        "return": "number",
        "arguments": {}
      },
      "tenantId": {
        "return": "number",
        "arguments": {}
      },
      "visible": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

LearningHubPagesReorderInput: object

learningHubPages: LearningHubPageUpdateInput

Example

{
  "learningHubPages": [
    {
      "id": "string",
      "html": "string",
      "name": "string",
      "visible": "boolean",
      "sortOrder": "number"
    }
  ]
}

LearningHubPagesReorderMutationPayload: object

Autogenerated return type of LearningHubPagesReorderMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

LearningPath: object

Represents information about a Learning Path.

bannerImageUrl: object: Image URL of the LearningPath
return: String arguments: object
description: object: Description of the LearningPath.
return: String arguments: object
id: object: ID of the LearningPath.
return: ID arguments: object
learnableConfiguration: object: LearnableConfiguration for the LearningPath.
return: LearnableConfiguration arguments: object
learningPathSections: object: Collection of LearningPathSections of a LearningPath.
return: LearningPathSectionAssociationConnection arguments: object after: String Returns the elements in the list that come after the specified cursor. before: String Returns the elements in the list that come before the specified cursor. first: Int Returns the first n elements from the list. last: Int Returns the last n elements from the list.
orderType: object: Order of the LearningPath.
return: String arguments: object
status: object: Status of a LearningPath: draft, published.
return: String arguments: object
stepsCount: object: Number of learnable items of a LearningPath.
return: Int arguments: object
title: object: Title of the LearningPath.
return: String arguments: object

Example

{
  "bannerImageUrl": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "learnableConfiguration": {
    "return": {
      "enableDisplayRecognitions": {
        "return": "boolean",
        "arguments": {}
      },
      "enableInBrowse": {
        "return": "boolean",
        "arguments": {}
      },
      "label": {
        "return": "string",
        "arguments": {}
      },
      "learnableId": {
        "return": "string",
        "arguments": {}
      },
      "learnableType": {
        "return": "string",
        "arguments": {}
      },
      "purchaseType": {
        "return": "string",
        "arguments": {}
      },
      "purchaseUrl": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "learningPathSections": {
    "return": {
      "edges": {
        "return": [
          {
            "cursor": {
              "return": "string",
              "arguments": {}
            },
            "node": {
              "return": {
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "learnableItems": {
                  "return": {
                    "edges": {
                      "return": [
                        {
                          "cursor": {
                            "return": "string",
                            "arguments": {}
                          },
                          "node": {
                            "return": {
                              "id": {
                                "return": "string",
                                "arguments": {}
                              },
                              "resourceId": {
                                "return": "string",
                                "arguments": {}
                              },
                              "resourceImage": {
                                "return": "string",
                                "arguments": {}
                              },
                              "resourceSummary": {
                                "return": "string",
                                "arguments": {}
                              },
                              "resourceTitle": {
                                "return": "string",
                                "arguments": {}
                              },
                              "resourceType": {
                                "return": "string"
                              }
                            }
                          }
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        ]
      }
    }
  }
}

LearningPathConnection: object

The connection type for LearningPath.

edges: object: A list of edges.
return: LearningPathEdge arguments: object
nodes: object: A list of nodes.
return: LearningPath arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "bannerImageUrl": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "learnableConfiguration": {
              "return": {
                "enableDisplayRecognitions": {
                  "return": "boolean",
                  "arguments": {}
                },
                "enableInBrowse": {
                  "return": "boolean",
                  "arguments": {}
                },
                "label": {
                  "return": "string",
                  "arguments": {}
                },
                "learnableId": {
                  "return": "string",
                  "arguments": {}
                },
                "learnableType": {
                  "return": "string",
                  "arguments": {}
                },
                "purchaseType": {
                  "return": "string",
                  "arguments": {}
                },
                "purchaseUrl": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "learningPathSections": {
              "return": {
                "edges": {
                  "return": [
                    {
                      "cursor": {
                        "return": "string",
                        "arguments": {}
                      },
                      "node": {
                        "return": {
                          "id": {
                            "return": "string",
                            "arguments": {}
                          },
                          "learnableItems": {
                            "return": {
                              "edges": {
                                "return": [
                                  {
                                    "cursor": {
                                      "return": "string",
                                      "arguments": {}
                                    },
                                    "node": {
                                      "return": {
                                        "id": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "resourceId": {
                                          "return": "string",
                                          "arguments": {}
                                        },
                                        "resourceImage": {
                                          "return": "string",
                                          "arguments": {}
                                        }
                                      }
                                    }
                                  }
                                ]
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}

LearningPathEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: LearningPath arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "bannerImageUrl": {
        "return": "string",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "learnableConfiguration": {
        "return": {
          "enableDisplayRecognitions": {
            "return": "boolean",
            "arguments": {}
          },
          "enableInBrowse": {
            "return": "boolean",
            "arguments": {}
          },
          "label": {
            "return": "string",
            "arguments": {}
          },
          "learnableId": {
            "return": "string",
            "arguments": {}
          },
          "learnableType": {
            "return": "string",
            "arguments": {}
          },
          "purchaseType": {
            "return": "string",
            "arguments": {}
          },
          "purchaseUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "learningPathSections": {
        "return": {
          "edges": {
            "return": [
              {
                "cursor": {
                  "return": "string",
                  "arguments": {}
                },
                "node": {
                  "return": {
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "learnableItems": {
                      "return": {
                        "edges": {
                          "return": [
                            {
                              "cursor": {
                                "return": "string",
                                "arguments": {}
                              },
                              "node": {
                                "return": {
                                  "id": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "resourceId": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "resourceImage": {
                                    "return": "string",
                                    "arguments": {}
                                  },
                                  "resourceSummary": {
                                    "return": "string",
                                    "arguments": {}
                                  }
                                }
                              }
                            }
                          ]
                        }
                      }
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

LearningPathFilter: object

Input fields for learning path search

ids: ID: Search by IDs
query: String: Smart search across ID and title

Example

{
  "ids": [
    "string"
  ],
  "query": "string"
}

LearningPathSection: object

Represents information about a Learning Path Section.

id: object: ID of the LearningPathSection.
return: ID arguments: object
learnableItems: object: Collection of LearnableItems of a LearningPathSection.
return: LearnableItemAssociationConnection arguments: object after: String Returns the elements in the list that come after the specified cursor. before: String Returns the elements in the list that come before the specified cursor. first: Int Returns the first n elements from the list. last: Int Returns the last n elements from the list.
name: object: Name of the LearningPathSection.
return: String arguments: object
sortOrder: object: Order of the LearningPathSection.
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "learnableItems": {
    "return": {
      "edges": {
        "return": [
          {
            "cursor": {
              "return": "string",
              "arguments": {}
            },
            "node": {
              "return": {
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceId": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceImage": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceSummary": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceType": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "nodes": {
        "return": [
          {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "resourceId": {
              "return": "string",
              "arguments": {}
            },
            "resourceImage": {
              "return": "string",
              "arguments": {}
            },
            "resourceSummary": {
              "return": "string",
              "arguments": {}
            },
            "resourceTitle": {
              "return": "string",
              "arguments": {}
            },
            "resourceType": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "pageInfo": {
        "return": {
          "endCursor": {
            "return": "string",
            "arguments": {}
          },
          "hasNextPage": {
            "return": "boolean",
            "arguments": {}
          },
          "hasPreviousPage": {
            "return": "boolean",
            "arguments": {}
          },
          "startCursor": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "totalCount": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

LearningPathSectionAssociationConnection: object

The connection type for LearningPathSection.

edges: object: A list of edges.
return: LearningPathSectionEdge arguments: object
nodes: object: A list of nodes.
return: LearningPathSection arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "learnableItems": {
              "return": {
                "edges": {
                  "return": [
                    {
                      "cursor": {
                        "return": "string",
                        "arguments": {}
                      },
                      "node": {
                        "return": {
                          "id": {
                            "return": "string",
                            "arguments": {}
                          },
                          "resourceId": {
                            "return": "string",
                            "arguments": {}
                          },
                          "resourceImage": {
                            "return": "string",
                            "arguments": {}
                          },
                          "resourceSummary": {
                            "return": "string",
                            "arguments": {}
                          },
                          "resourceTitle": {
                            "return": "string",
                            "arguments": {}
                          },
                          "resourceType": {
                            "return": "string",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      }
                    }
                  ],
                  "arguments": {}
                },
                "nodes": {
                  "return": [
                    {
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "resourceId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "resourceImage": {
                        "return": "string",
                        "arguments": {}
                      },
                      "resourceSummary": {
                        "return": "string",
                        "arguments": {}
                      },
                      "resourceTitle": {
                        "return": "string",
                        "arguments": {}
                      },
                      "resourceType": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  ],
                  "arguments": {}
                },
                "pageInfo": {
                  "return": {
                    "endCursor": {
                      "return": "string",
                      "arguments": {}
                    },
                    "hasNextPage": {
                      "return": "boolean",
                      "arguments": {}
                    },
                    "hasPreviousPage": {
                      "return": "boolean",
                      "arguments": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

LearningPathSectionEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: LearningPathSection arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "learnableItems": {
        "return": {
          "edges": {
            "return": [
              {
                "cursor": {
                  "return": "string",
                  "arguments": {}
                },
                "node": {
                  "return": {
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "resourceId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "resourceImage": {
                      "return": "string",
                      "arguments": {}
                    },
                    "resourceSummary": {
                      "return": "string",
                      "arguments": {}
                    },
                    "resourceTitle": {
                      "return": "string",
                      "arguments": {}
                    },
                    "resourceType": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "nodes": {
            "return": [
              {
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceId": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceImage": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceSummary": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceTitle": {
                  "return": "string",
                  "arguments": {}
                },
                "resourceType": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "pageInfo": {
            "return": {
              "endCursor": {
                "return": "string",
                "arguments": {}
              },
              "hasNextPage": {
                "return": "boolean",
                "arguments": {}
              },
              "hasPreviousPage": {
                "return": "boolean",
                "arguments": {}
              },
              "startCursor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

LearningPathSortAttributes: string

object id: Sort by ID
object title: Sort by title
object order_type: Sort by order type
object status: Sort by status

LearningPathSortOrderFilter: object

order: SortOrder
by: LearningPathSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

LegacyHierarchyNodeEnum: string

object AdministrativeDivision
object Institution
object District

License: object

Represents information about an individual license.

activatedAt: object: Activation date of the License.
return: ISO8601Date arguments: object
branchPlan: object: BranchPlan to which the license is associated
return: BranchPlan arguments: object
branchPlanId: object: ID of the associated BranchPlan
return: ID arguments: object
createdAt: object: Timestamp when the License was created.
return: ISO8601DateTime arguments: object
enrollments: object: List of Enrollments (resolver) associated with the License.
return: EnrollmentAssociationConnection arguments: object offset: Int The index of the first item in the records to be returned limit: Int 25 The maximum number of records to be returned sort: EnrollmentSortOrderFilter after: String Returns the elements in the list that come after the specified cursor. before: String Returns the elements in the list that come before the specified cursor. first: Int Returns the first n elements from the list. last: Int Returns the last n elements from the list.
extendable: object: Indicates whether the license may be extended.
return: Boolean arguments: object
id: object: ID of the License.
return: ID arguments: object
isEnterpriseLicense: object: Indicates if license is tied to any enerprise contracts.
return: Boolean arguments: object
maxExtensionDate: object: Timestamp of maximum date beyond which extension is not permitted.
return: ISO8601DateTime arguments: object
planAccessExpirationDate: object: Final access date of the plan.
return: ISO8601Date arguments: object
planKind: object: Kind of the plan: One of "Lifetime Access", "Enterprise", "Subject Access", "Multiple Access", "MultipleAccess", "Library", "Single Access", "Solo", "Upfront Charge", etc.
return: String arguments: object
seatExclusion: object: Indicates if the license is excluded from seat counts.
return: Boolean arguments: object
source: object: Source of the License.
return: String arguments: object
state: object: Status of the License.
return: StateEnum arguments: object
user: object: User associated with the License.
return: User arguments: object
validUntil: object: Enrolled until date of the License.
return: ISO8601Date arguments: object

Example

{
  "activatedAt": {
    "return": "object",
    "arguments": {}
  },
  "branchPlan": {
    "return": {
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {}
            }
          }
        }
      }
    }
  }
}

LicenseAssociationConnection: object

The connection type for License.

edges: object: A list of edges.
return: LicenseEdge arguments: object
nodes: object: A list of nodes.
return: License arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "activatedAt": {
              "return": "object",
              "arguments": {}
            },
            "branchPlan": {
              "return": {
                "activatedLicenseCount": {
                  "return": "number",
                  "arguments": {}
                },
                "activeLicenseCount": {
                  "return": "number",
                  "arguments": {}
                },
                "availableSeatCount": {
                  "return": "number",
                  "arguments": {}
                },
                "branch": {
                  "return": {
                    "appliedBranding": {
                      "return": {
                        "brandableId": {
                          "return": "string",
                          "arguments": {}
                        },
                        "brandableType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "colorLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "emailLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "footer": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "isDefault": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "variables": {
                              "return": "object",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "marketingPage": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "isDefault": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "variables": {
                              "return": "object",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

LicenseConnection: object

The connection type for License.

edges: object: A list of edges.
return: LicenseEdge arguments: object
nodes: object: A list of nodes.
return: License arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "activatedAt": {
              "return": "object",
              "arguments": {}
            },
            "branchPlan": {
              "return": {
                "activatedLicenseCount": {
                  "return": "number",
                  "arguments": {}
                },
                "activeLicenseCount": {
                  "return": "number",
                  "arguments": {}
                },
                "availableSeatCount": {
                  "return": "number",
                  "arguments": {}
                },
                "branch": {
                  "return": {
                    "appliedBranding": {
                      "return": {
                        "brandableId": {
                          "return": "string",
                          "arguments": {}
                        },
                        "brandableType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "colorLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "emailLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "footer": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "isDefault": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "variables": {
                              "return": "object",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "marketingPage": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "isDefault": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "variables": {
                              "return": "object",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

LicenseCreateInput: object

userIds: ID
branchPlanId: ID
planId: ID
seatExclusion: Boolean false

Example

{
  "userIds": [
    "string"
  ],
  "branchPlanId": "string",
  "planId": "string",
  "seatExclusion": "boolean"
}

LicenseCreateMutationPayload: object

Autogenerated return type of LicenseCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
licenses: object: License records created by the mutation.
return: License arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "licenses": {
    "return": [
      {
        "activatedAt": {
          "return": "object",
          "arguments": {}
        },
        "branchPlan": {
          "return": {
            "activatedLicenseCount": {
              "return": "number",
              "arguments": {}
            },
            "activeLicenseCount": {
              "return": "number",
              "arguments": {}
            },
            "availableSeatCount": {
              "return": "number",
              "arguments": {}
            },
            "branch": {
              "return": {
                "appliedBranding": {
                  "return": {
                    "brandableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "brandableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "colorLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "emailLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "footer": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "marketingPage": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

LicenseEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: License arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "activatedAt": {
        "return": "object",
        "arguments": {}
      },
      "branchPlan": {
        "return": {
          "activatedLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "activeLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "availableSeatCount": {
            "return": "number",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "mobileIconUrl": {
                    "return": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

LicenseFilter: object

Input fields for license search

ids: ID: Search by IDs
userId: String: Search by user_id
branchPlanIds: ID: Search by BranchPlan ID
userQuery: String: Smart search across user ID, name, and email

Example

{
  "ids": [
    "string"
  ],
  "userId": "string",
  "branchPlanIds": [
    "string"
  ],
  "userQuery": "string"
}

LicenseRemoveMutationInput: object

Autogenerated input type of LicenseRemoveMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

LicenseRemoveMutationPayload: object

Autogenerated return type of LicenseRemoveMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
license: object: License resource participating in the mutation.
return: License arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "license": {
    "return": {
      "activatedAt": {
        "return": "object",
        "arguments": {}
      },
      "branchPlan": {
        "return": {
          "activatedLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "activeLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "availableSeatCount": {
            "return": "number",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

LicenseSortAttributes: string

object id: Sort by ID
object activated_at: Sort by activation date
object valid_until: Sort by valid until date
object state: Sort by state
object created_at: Sort by time created
object seat_exclusion: Sort by seat exclusion
object user_id: Sort by User ID
object user_sis_id: Sort by User SIS ID

LicenseSortOrderFilter: object

order: SortOrder
by: LicenseSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

LicenseUpdateInput: object

id: ID
validUntil: ISO8601Date

Example

{
  "id": "string",
  "validUntil": "object"
}

LicenseUpdateMutationPayload: object

Autogenerated return type of LicenseUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
license: object: License resource participating in the mutation.
return: License arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "license": {
    "return": {
      "activatedAt": {
        "return": "object",
        "arguments": {}
      },
      "branchPlan": {
        "return": {
          "activatedLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "activeLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "availableSeatCount": {
            "return": "number",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Locale: object

Represents information on locales

defaults: object: Default locales in JSON.
return: JSON arguments: object
id: object: ID of the LocaleType.
return: Int arguments: object
overrides: object: Overrides of default locales in JSON.
return: JSON arguments: object

Example

{
  "defaults": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "number",
    "arguments": {}
  },
  "overrides": {
    "return": "object",
    "arguments": {}
  }
}

LocaleConnection: object

The connection type for Locale.

edges: object: A list of edges.
return: LocaleEdge arguments: object
nodes: object: A list of nodes.
return: Locale arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "defaults": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "number",
              "arguments": {}
            },
            "overrides": {
              "return": "object",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "defaults": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "number",
          "arguments": {}
        },
        "overrides": {
          "return": "object",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

LocaleEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Locale arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "defaults": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "number",
        "arguments": {}
      },
      "overrides": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

LocaleFilter: object

Input fields for locale search

language: String: Search by language

Example

{
  "language": "string"
}

LocaleUpdateInput: object

id: Int
overrides: JSON

Example

{
  "id": "number",
  "overrides": "object"
}

LocaleUpdateMutationPayload: object

Autogenerated return type of LocaleUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
locales: object: Locale resource participating in the mutation.
return: Locale arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "locales": {
    "return": {
      "defaults": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "number",
        "arguments": {}
      },
      "overrides": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

LoginTracking: object

Represents information about the login tracking of an user

attemptedAt: object: Time of the LoginTracking.
return: ISO8601DateTime arguments: object
browser: object: Browser of the LoginTracking.
return: String arguments: object
id: object: ID of the LoginTracking.
return: ID arguments: object
ip: object: IP Address of the LoginTracking.
return: String arguments: object
operatingSystem: object: Operating system of the LoginTracking.
return: String arguments: object
success: object: Indicates if the login attempt was successful.
return: Boolean arguments: object

Example

{
  "attemptedAt": {
    "return": "object",
    "arguments": {}
  },
  "browser": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "ip": {
    "return": "string",
    "arguments": {}
  },
  "operatingSystem": {
    "return": "string",
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

LoginTrackingAssociationConnection: object

The connection type for LoginTracking.

edges: object: A list of edges.
return: LoginTrackingEdge arguments: object
nodes: object: A list of nodes.
return: LoginTracking arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "attemptedAt": {
              "return": "object",
              "arguments": {}
            },
            "browser": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "ip": {
              "return": "string",
              "arguments": {}
            },
            "operatingSystem": {
              "return": "string",
              "arguments": {}
            },
            "success": {
              "return": "boolean",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "attemptedAt": {
          "return": "object",
          "arguments": {}
        },
        "browser": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "ip": {
          "return": "string",
          "arguments": {}
        },
        "operatingSystem": {
          "return": "string",
          "arguments": {}
        },
        "success": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

LoginTrackingConnection: object

The connection type for LoginTracking.

edges: object: A list of edges.
return: LoginTrackingEdge arguments: object
nodes: object: A list of nodes.
return: LoginTracking arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "attemptedAt": {
              "return": "object",
              "arguments": {}
            },
            "browser": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "ip": {
              "return": "string",
              "arguments": {}
            },
            "operatingSystem": {
              "return": "string",
              "arguments": {}
            },
            "success": {
              "return": "boolean",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "attemptedAt": {
          "return": "object",
          "arguments": {}
        },
        "browser": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "ip": {
          "return": "string",
          "arguments": {}
        },
        "operatingSystem": {
          "return": "string",
          "arguments": {}
        },
        "success": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

LoginTrackingEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: LoginTracking arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "attemptedAt": {
        "return": "object",
        "arguments": {}
      },
      "browser": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "ip": {
        "return": "string",
        "arguments": {}
      },
      "operatingSystem": {
        "return": "string",
        "arguments": {}
      },
      "success": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

LoginTrackingSortAttributes: string

object ip: Sort by ip
object success: Sort by success status
object attempted_at: Sort by attempted date

LoginTrackingSortOrderFilter: object

order: SortOrder
by: LoginTrackingSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

LtiDeployment: object

Represents information about a Learning Tools Interoperability (LTI) Tool Deployment.

branch: object: Branch associated with the LTI Deployment.
return: Branch arguments: object
contentPackages: object: List of ContentPackages (resolver) permitted by the LTI Deployment.
return: ContentPackage arguments: object
createdAt: object: Timestamp when the LTI Deployment was created.
return: ISO8601DateTime arguments: object
enableNrps: object: Indicates if it enables nightly NRPS job
return: String arguments: object
externalId: object: External Deployment ID of the LTI Deployment.
return: String arguments: object
id: object: ID of the LTI Deployment.
return: ID arguments: object
ltiContextClaimType: object: LTI Claim Context
return: String arguments: object
name: object: Name of the LTI Deployment.
return: String arguments: object
tool: object: LTI Tool associated with the LTI Deployment.
return: LtiTool arguments: object

Example

{
  "branch": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "marketingPage": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "mobileIconUrl": {
            "return": "string",
            "arguments": {}
          },
          "primaryColor": {
            "return": "string",
            "arguments": {}
          },
          "secondaryColor": {
            "return": "string",
            "arguments": {}
          },
          "whiteLogoUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "branding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {}
        }
      }
    }
  }
}

LtiDeploymentConnection: object

The connection type for LtiDeployment.

edges: object: A list of edges.
return: LtiDeploymentEdge arguments: object
nodes: object: A list of nodes.
return: LtiDeployment arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "branch": {
              "return": {
                "appliedBranding": {
                  "return": {
                    "brandableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "brandableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "colorLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "emailLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "footer": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "marketingPage": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "mobileIconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "primaryColor": {
                      "return": "string",
                      "arguments": {}
                    },
                    "secondaryColor": {
                      "return": "string",
                      "arguments": {}
                    },
                    "whiteLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "branding": {}
              }
            }
          }
        }
      }
    ]
  }
}

LtiDeploymentCreateInput: object

name: String
externalId: String
toolId: ID
branchId: ID
enableNrps: Boolean
contentPackageIds: ID

Example

{
  "name": "string",
  "externalId": "string",
  "toolId": "string",
  "branchId": "string",
  "enableNrps": "boolean",
  "contentPackageIds": [
    "string"
  ]
}

LtiDeploymentCreateMutationPayload: object

Autogenerated return type of LtiDeploymentCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
ltiDeployment: object: LTI Deployment created by the mutation.
return: LtiDeployment arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "ltiDeployment": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

LtiDeploymentDeleteInput: object

id: ID

Example

{
  "id": "string"
}

LtiDeploymentDeleteMutationPayload: object

Autogenerated return type of LtiDeploymentDeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
ltiDeployment: object: LTI Deployment participating in the mutation.
return: LtiDeployment arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "ltiDeployment": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

LtiDeploymentEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: LtiDeployment arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {
                "return": "string",
                "arguments": {}
              },
              "whiteLogoUrl": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "branding": {
            "return": {
              "brandableId": {}
            }
          }
        }
      }
    }
  }
}

LtiDeploymentFilter: object

Input fields for LTI Deployment search

ids: ID: Search by IDs
toolId: ID: Search for LTI Deployments associated with a LTI Tool
query: String: Smart search by ID, Name, and Deployment ID

Example

{
  "ids": [
    "string"
  ],
  "toolId": "string",
  "query": "string"
}

LtiDeploymentSortAttributes: string

object id: Sort by ID
object name: Sort by Name
object external_id: Sort by external deployment ID.
object created_at: Sort by time created.

LtiDeploymentSortOrderFilter: object

order: SortOrder
by: LtiDeploymentSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

LtiDeploymentUpdateCoursesInput: object

id: ID
contentPackageIdsToAdd: ID
contentPackageIdsToRemove: ID

Example

{
  "id": "string",
  "contentPackageIdsToAdd": [
    "string"
  ],
  "contentPackageIdsToRemove": [
    "string"
  ]
}

LtiDeploymentUpdateCoursesMutationPayload: object

Autogenerated return type of LtiDeploymentUpdateCoursesMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
ltiDeployment: object: LTI Deployment updated by the mutation.
return: LtiDeployment arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "ltiDeployment": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

LtiDeploymentUpdateInput: object

id: ID
name: String
externalId: String
branchId: ID
enableNrps: Boolean
ltiContextClaimType: String

Example

{
  "id": "string",
  "name": "string",
  "externalId": "string",
  "branchId": "string",
  "enableNrps": "boolean",
  "ltiContextClaimType": "string"
}

LtiDeploymentUpdateMutationPayload: object

Autogenerated return type of LtiDeploymentUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
ltiDeployment: object: LTI Deployment updated by the mutation.
return: LtiDeployment arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "ltiDeployment": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

LtiTool: object

Represents information about a Learning Tools Interoperability (LTI) Tool.

branch: object: Branch associated with the LTI Tool.
return: Branch arguments: object
clientId: object: Client ID of the LTI Tool.
return: String arguments: object
createdAt: object: Timestamp when the LTI Tool was created.
return: ISO8601DateTime arguments: object
deepLinkingUrl: object: Deep Linking URL of the LTI Tool.
return: String arguments: object
id: object: ID of the LTI Tool.
return: ID arguments: object
jwksUrl: object: JWKS URL of the LTI Tool.
return: String arguments: object
keysetUrl: object: Keyset URL of the LTI Tool.
return: String arguments: object
launchesEndpoint: object: Launches Endpoint of the LTI Tool.
return: String arguments: object
name: object: Name of the LTI Tool.
return: String arguments: object
oauth2Aud: object: OAuth2 AUD of the LTI Tool.
return: String arguments: object
oauth2Url: object: OAuth2 URL of the LTI Tool.
return: String arguments: object
oidcLoginInitiationUrl: object: OIDC Login Initiation URL of the LTI Tool.
return: String arguments: object
platformOidcAuthUrl: object: OAuth2 URL of the LTI Tool.
return: String arguments: object
publicKey: object: Public Key of the LTI Tool.
return: String arguments: object
roleMapping: object: Mapping of the LTI roles to application roles.
return: JSON arguments: object
version: object: Version of the LTI Tool.
return: String arguments: object

Example

{
  "branch": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "marketingPage": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "mobileIconUrl": {
            "return": "string",
            "arguments": {}
          },
          "primaryColor": {
            "return": "string",
            "arguments": {}
          },
          "secondaryColor": {
            "return": "string",
            "arguments": {}
          },
          "whiteLogoUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "branding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {}
        }
      }
    }
  }
}

LtiToolConnection: object

The connection type for LtiTool.

edges: object: A list of edges.
return: LtiToolEdge arguments: object
nodes: object: A list of nodes.
return: LtiTool arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "branch": {
              "return": {
                "appliedBranding": {
                  "return": {
                    "brandableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "brandableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "colorLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "emailLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "footer": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "marketingPage": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "mobileIconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "primaryColor": {
                      "return": "string",
                      "arguments": {}
                    },
                    "secondaryColor": {
                      "return": "string",
                      "arguments": {}
                    },
                    "whiteLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "branding": {}
              }
            }
          }
        }
      }
    ]
  }
}

LtiToolCreateInput: object

name: String
branchId: ID

Example

{
  "name": "string",
  "branchId": "string"
}

LtiToolCreateMutationPayload: object

Autogenerated return type of LtiToolCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
ltiTool: object: LTI Tool created by the mutation.
return: LtiTool arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "ltiTool": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

LtiToolDeleteInput: object

id: ID

Example

{
  "id": "string"
}

LtiToolDeleteMutationPayload: object

Autogenerated return type of LtiToolDeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
ltiTool: object: LTI Tool participating in the mutation.
return: LtiTool arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "ltiTool": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

LtiToolEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: LtiTool arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {
                "return": "string",
                "arguments": {}
              },
              "whiteLogoUrl": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "branding": {
            "return": {
              "brandableId": {}
            }
          }
        }
      }
    }
  }
}

LtiToolFilter: object

Input fields for LTI Tool search

ids: ID: Search by IDs
branchId: ID: Search for LTI Tools associated with a Branch and its ancestor branches
query: String: Smart search by ID, Name, and Client ID

Example

{
  "ids": [
    "string"
  ],
  "branchId": "string",
  "query": "string"
}

LtiToolSortAttributes: string

object id: Sort by ID
object name: Sort by Name
object client_id: Sort by Client ID.
object created_at: Sort by time created.

LtiToolSortOrderFilter: object

order: SortOrder
by: LtiToolSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

LtiToolUpdateInput: object

id: ID
name: String
clientId: ID
keysetUrl: String
oauth2Url: String
oauth2Aud: String
platformOidcAuthUrl: String
roleMapping: JSON

Example

{
  "id": "string",
  "name": "string",
  "clientId": "string",
  "keysetUrl": "string",
  "oauth2Url": "string",
  "oauth2Aud": "string",
  "platformOidcAuthUrl": "string",
  "roleMapping": "object"
}

LtiToolUpdateMutationPayload: object

Autogenerated return type of LtiToolUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
ltiTool: object: LTI Tool updated by the mutation.
return: LtiTool arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "ltiTool": {
    "return": {
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

MarketingPageUpdateMutationPayload: object

Autogenerated return type of MarketingPageUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
marketingPage: object: MarketingPage resource participating in the mutation.
return: PageComponent arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "marketingPage": {
    "return": {
      "html": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "isDefault": {
        "return": "boolean",
        "arguments": {}
      },
      "variables": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

Message: object

Represents information about a message of the platform

body: object: Body of the Message
return: String arguments: object
contentPackage: object: ContentPackage of the Message.
return: ContentPackage arguments: object
createdAt: object: Datetime of when the Message was created
return: ISO8601DateTime arguments: object
endDate: object: The end date for an automated Message.
return: ISO8601DateTime arguments: object
eventTrigger: object: The EventTrigger that subscribes to events for an automated Message delivery.
return: EventTrigger arguments: object
id: object: ID of the Message.
return: ID arguments: object
startDate: object: The start date for the Message.
return: ISO8601DateTime arguments: object
state: object: The activation state of the Message.
return: MessageStateEnum arguments: object
title: object: Title of the Message
return: String arguments: object
userSegment: object: The UserSegment specifying to which users this Message will be delivered.
return: UserSegment arguments: object

Example

{
  "body": {
    "return": "string",
    "arguments": {}
  },
  "contentPackage": {
    "return": {
      "bannerImageUrl": {
        "return": "string",
        "arguments": {}
      },
      "collaboratorEmails": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "courseType": {
        "return": "string",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "enrollmentsCount": {
        "return": "number",
        "arguments": {}
      },
      "featureAccesses": {
        "return": [
          {
            "allowed": {
              "return": "boolean",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "featureConfiguration": {
              "return": {
                "configuration": {
                  "return": "object",
                  "arguments": {}
                },
                "configurationTypesJson": {
                  "return": "object",
                  "arguments": {}
                },
                "controllableId": {
                  "return": "string",
                  "arguments": {}
                },
                "controllableType": {
                  "return": "string",
                  "arguments": {}
                },
                "featureId": {
                  "return": "string",
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            },
            "group": {
              "return": "string",
              "arguments": {}
            },
            "manageable": {
              "return": "boolean",
              "arguments": {}
            },
            "managedByControllableTypes": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            },
            "summary": {
              "return": "string",
              "arguments": {}
            },
            "title": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "features": {
        "return": "object",
        "arguments": {}
      },
      "graderCategories": {}
    }
  }
}

MessageConnection: object

The connection type for Message.

edges: object: A list of edges.
return: MessageEdge arguments: object
nodes: object: A list of nodes.
return: Message arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "body": {
              "return": "string",
              "arguments": {}
            },
            "contentPackage": {
              "return": {
                "bannerImageUrl": {
                  "return": "string",
                  "arguments": {}
                },
                "collaboratorEmails": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "courseType": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "enrollmentsCount": {
                  "return": "number",
                  "arguments": {}
                },
                "featureAccesses": {
                  "return": [
                    {
                      "allowed": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "featureConfiguration": {
                        "return": {
                          "configuration": {
                            "return": "object",
                            "arguments": {}
                          },
                          "configurationTypesJson": {
                            "return": "object",
                            "arguments": {}
                          },
                          "controllableId": {
                            "return": "string",
                            "arguments": {}
                          },
                          "controllableType": {
                            "return": "string",
                            "arguments": {}
                          },
                          "featureId": {
                            "return": "string",
                            "arguments": {}
                          },
                          "slug": {
                            "return": "string",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "group": {
                        "return": "string",
                        "arguments": {}
                      },
                      "manageable": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "managedByControllableTypes": {
                        "return": [
                          "string"
                        ],
                        "arguments": {}
                      },
                      "slug": {
                        "return": "string",
                        "arguments": {}
                      },
                      "summary": {
                        "return": "string"
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}

MessageCreateInput: object

title: String
body: String
contentPackageId: ID
userSegment: UserSegmentCreateInput
startDate: ISO8601DateTime
endDate: ISO8601DateTime
eventTrigger: EventTriggerCreateInput

Example

{
  "title": "string",
  "body": "string",
  "contentPackageId": "string",
  "userSegment": {
    "components": [
      {
        "componentId": "string",
        "componentType": "string",
        "accessContextId": "string",
        "accessContextType": "string"
      }
    ]
  },
  "startDate": "object",
  "endDate": "object",
  "eventTrigger": {
    "eventType": "string",
    "contentLocation": "string",
    "enabled": "boolean"
  }
}

MessageCreateMutationPayload: object

Autogenerated return type of MessageCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
message: object: Message resource participating in the mutation.
return: Message arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "message": {
    "return": {
      "body": {
        "return": "string",
        "arguments": {}
      },
      "contentPackage": {
        "return": {
          "bannerImageUrl": {
            "return": "string",
            "arguments": {}
          },
          "collaboratorEmails": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "courseType": {
            "return": "string",
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "enrollmentsCount": {
            "return": "number",
            "arguments": {}
          },
          "featureAccesses": {
            "return": [
              {
                "allowed": {
                  "return": "boolean",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "featureConfiguration": {
                  "return": {
                    "configuration": {
                      "return": "object",
                      "arguments": {}
                    },
                    "configurationTypesJson": {
                      "return": "object",
                      "arguments": {}
                    },
                    "controllableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "controllableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "featureId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "slug": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "group": {
                  "return": "string",
                  "arguments": {}
                },
                "manageable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "managedByControllableTypes": {
                  "return": [
                    null
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

MessageDeleteInput: object

id: ID

Example

{
  "id": "string"
}

MessageDeleteMutationPayload: object

Autogenerated return type of MessageDeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
message: object: Message resource participating in the mutation.
return: Message arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "message": {
    "return": {
      "body": {
        "return": "string",
        "arguments": {}
      },
      "contentPackage": {
        "return": {
          "bannerImageUrl": {
            "return": "string",
            "arguments": {}
          },
          "collaboratorEmails": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "courseType": {
            "return": "string",
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "enrollmentsCount": {
            "return": "number",
            "arguments": {}
          },
          "featureAccesses": {
            "return": [
              {
                "allowed": {
                  "return": "boolean",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "featureConfiguration": {
                  "return": {
                    "configuration": {
                      "return": "object",
                      "arguments": {}
                    },
                    "configurationTypesJson": {
                      "return": "object",
                      "arguments": {}
                    },
                    "controllableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "controllableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "featureId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "slug": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "group": {
                  "return": "string",
                  "arguments": {}
                },
                "manageable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "managedByControllableTypes": {
                  "return": [
                    null
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

MessageEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Message arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "body": {
        "return": "string",
        "arguments": {}
      },
      "contentPackage": {
        "return": {
          "bannerImageUrl": {
            "return": "string",
            "arguments": {}
          },
          "collaboratorEmails": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "courseType": {
            "return": "string",
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "enrollmentsCount": {
            "return": "number",
            "arguments": {}
          },
          "featureAccesses": {
            "return": [
              {
                "allowed": {
                  "return": "boolean",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "featureConfiguration": {
                  "return": {
                    "configuration": {
                      "return": "object",
                      "arguments": {}
                    },
                    "configurationTypesJson": {
                      "return": "object",
                      "arguments": {}
                    },
                    "controllableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "controllableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "featureId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "slug": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "group": {
                  "return": "string",
                  "arguments": {}
                },
                "manageable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "managedByControllableTypes": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                },
                "summary": {
                  "return": "string",
                  "arguments": {}
                },
                "title": {
                  "return": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}

MessageFilter: object

Input fields for message search

ids: ID: Search by IDs

Example

{
  "ids": [
    "string"
  ]
}

MessageSortAttributes: string

object id: Sort by ID
object title: Sort by Title
object created_at: Sort by time created

MessageSortOrderFilter: object

order: SortOrder
by: MessageSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

MessageStateEnum: string

object Active
object Disabled
object Expired
object Scheduled

MessageUpdateInput: object

id: ID
title: String
body: String
contentPackageId: ID
startDate: ISO8601DateTime
endDate: ISO8601DateTime
eventTrigger: EventTriggerCreateInput

Example

{
  "id": "string",
  "title": "string",
  "body": "string",
  "contentPackageId": "string",
  "startDate": "object",
  "endDate": "object",
  "eventTrigger": {
    "eventType": "string",
    "contentLocation": "string",
    "enabled": "boolean"
  }
}

MessageUpdateMutationPayload: object

Autogenerated return type of MessageUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
message: object: Message resource participating in the mutation.
return: Message arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "message": {
    "return": {
      "body": {
        "return": "string",
        "arguments": {}
      },
      "contentPackage": {
        "return": {
          "bannerImageUrl": {
            "return": "string",
            "arguments": {}
          },
          "collaboratorEmails": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "courseType": {
            "return": "string",
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "enrollmentsCount": {
            "return": "number",
            "arguments": {}
          },
          "featureAccesses": {
            "return": [
              {
                "allowed": {
                  "return": "boolean",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "featureConfiguration": {
                  "return": {
                    "configuration": {
                      "return": "object",
                      "arguments": {}
                    },
                    "configurationTypesJson": {
                      "return": "object",
                      "arguments": {}
                    },
                    "controllableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "controllableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "featureId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "slug": {
                      "return": "string",
                      "arguments": {}
                    }
                  },
                  "arguments": {}
                },
                "group": {
                  "return": "string",
                  "arguments": {}
                },
                "manageable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "managedByControllableTypes": {
                  "return": [
                    null
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

Milestone: object

Represents information about a milestone of the platform

id: object: ID of the Milestone.
return: ID arguments: object
title: object: Title of the Milestone
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "title": {
    "return": "string",
    "arguments": {}
  }
}

MilestoneConnection: object

The connection type for Milestone.

edges: object: A list of edges.
return: MilestoneEdge arguments: object
nodes: object: A list of nodes.
return: Milestone arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "title": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "title": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

MilestoneEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Milestone arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "title": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

MilestoneFilter: object

Input fields for milestone search

ids: ID: Search by IDs
contentPackageId: ID: Search by content package ID

Example

{
  "ids": [
    "string"
  ],
  "contentPackageId": "string"
}

MilestoneSortAttributes: string

object id: Sort by ID
object title: Sort by title

MilestoneSortOrderFilter: object

order: SortOrder
by: MilestoneSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

MutationResult: object

creationGuard: object: Message describing details of the mutation.
return: String arguments: object
errors: object: Array of RecordError errors from the service response.
return: RecordError arguments: object
success: object: Indicates successfull service response.
return: Boolean arguments: object
userRole: object: UserRole resource response for the mutation.
return: UserRole arguments: object

Example

{
  "creationGuard": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "userRole": {
    "return": {
      "accessContext": {
        "arguments": {}
      },
      "accessContextId": {
        "return": "string",
        "arguments": {}
      },
      "accessContextType": {
        "return": "string",
        "arguments": {}
      },
      "applicableAccessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "properties": {
        "return": "object",
        "arguments": {}
      },
      "role": {
        "return": {
          "accessContexts": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "editable": {
            "return": "boolean",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "permissionBased": {
            "return": "boolean",
            "arguments": {}
          },
          "permissions": {
            "return": [
              {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "action": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ]
          }
        }
      }
    }
  }
}

NavigationItem: object

Represents a navigation item within a navigable domain

configuration: object: Item configuration details in JSON.
return: JSON arguments: object
itemType: object: Type of the navigation item.
return: String arguments: object
landingPage: object: Indicates if item is the default landing page.
return: Boolean arguments: object
navigableId: object: Foreign key of navigable reference.
return: String arguments: object
navigableType: object: Type of navigable reference.
return: Boolean arguments: object
sortOrder: object: Order of the item.
return: Int arguments: object
visible: object: Indicates if item is displayed.
return: Boolean arguments: object

Example

{
  "configuration": {
    "return": "object",
    "arguments": {}
  },
  "itemType": {
    "return": "string",
    "arguments": {}
  },
  "landingPage": {
    "return": "boolean",
    "arguments": {}
  },
  "navigableId": {
    "return": "string",
    "arguments": {}
  },
  "navigableType": {
    "return": "boolean",
    "arguments": {}
  },
  "sortOrder": {
    "return": "number",
    "arguments": {}
  },
  "visible": {
    "return": "boolean",
    "arguments": {}
  }
}

NavigationItemCreateInput: object

itemType: String
landingPage: Boolean
sortOrder: Int
visible: Boolean
configuration: JSON

Example

{
  "itemType": "string",
  "landingPage": "boolean",
  "sortOrder": "number",
  "visible": "boolean",
  "configuration": "object"
}

PageComponent: object

Represents how a brandable resource's Page Components are structured

html: object: HTML that represents the PageComponent.
return: String arguments: object
id: object: ID of the PageComponent.
return: ID arguments: object
isDefault: object: Indicates if the PageComponent uses default HTML.
return: Boolean arguments: object
variables: object: Variables for the PageComponent in JSON.
return: JSON arguments: object

Example

{
  "html": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "isDefault": {
    "return": "boolean",
    "arguments": {}
  },
  "variables": {
    "return": "object",
    "arguments": {}
  }
}

PageComponentInput: object

id: ID
variables: JSON
html: String
isDefault: Boolean

Example

{
  "id": "string",
  "variables": "object",
  "html": "string",
  "isDefault": "boolean"
}

PageInfo: object

Information about pagination in a connection.

endCursor: object: When paginating forwards, the cursor to continue.
return: String arguments: object
hasNextPage: object: When paginating forwards, are there more items?
return: Boolean arguments: object
hasPreviousPage: object: When paginating backwards, are there more items?
return: Boolean arguments: object
startCursor: object: When paginating backwards, the cursor to continue.
return: String arguments: object

Example

{
  "endCursor": {
    "return": "string",
    "arguments": {}
  },
  "hasNextPage": {
    "return": "boolean",
    "arguments": {}
  },
  "hasPreviousPage": {
    "return": "boolean",
    "arguments": {}
  },
  "startCursor": {
    "return": "string",
    "arguments": {}
  }
}

PageTypeEnum: string

object internal
object custom

Permission: object

accessContexts: object: Array of Access Contexts of the Permission.
return: AccessContextEnum arguments: object
action: object: Action of the Permission.
return: String arguments: object
description: object: Description of the Permission.
return: String arguments: object
id: object: ID of the Permission.
return: ID arguments: object
resource: object: Resource of the Permission.
return: String arguments: object
slug: object: Slug of the Permission.
return: String arguments: object

Example

{
  "accessContexts": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "action": {
    "return": "string",
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "resource": {
    "return": "string",
    "arguments": {}
  },
  "slug": {
    "return": "string",
    "arguments": {}
  }
}

PermissionConnection: object

The connection type for Permission.

edges: object: A list of edges.
return: PermissionEdge arguments: object
nodes: object: A list of nodes.
return: Permission arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "accessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "action": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "resource": {
              "return": "string",
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "accessContexts": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "action": {
          "return": "string",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "resource": {
          "return": "string",
          "arguments": {}
        },
        "slug": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

PermissionEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Permission arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "accessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "action": {
        "return": "string",
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "resource": {
        "return": "string",
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

PermissionFilter: object

Input fields for permission search

accessContexts: AccessContextEnum: Search by access_contexts

Example

{
  "accessContexts": [
    "string"
  ]
}

Plan: object

Represents information about a contract Plan.

accessExpirationDate: object: Final access date of the Plan.
return: ISO8601Date arguments: object
activatedLicenseCount: object: Number of associated licenses that were activated
return: Int arguments: object
activeLicenseCount: object: Number of licenses that have learner activity
return: Int arguments: object
availableSeatCount: object: Number of seats available to be used
return: Int arguments: object
contentPackages: object: List of ContentPackages (resolver) authorized with the Plan.
return: ContentPackage arguments: object
duration: object: Duration of the BasePlanInterface
return: Int arguments: object
durationUnit: object: Duration units
return: String arguments: object
externalId: object: External ID of BasePlanInterface
return: String arguments: object
finalAccessDate: object: Final date when all learner access gets cut off
return: ISO8601Date arguments: object
finalAdminAccessDate: object: Final date when all admin access gets cut off
return: ISO8601Date arguments: object
firstActivationDate: object: First date when a learner can activate their access
return: ISO8601Date arguments: object
id: object: ID of the BasePlanInterface
return: ID arguments: object
initialDuration: object: Number of initial duration units of the Plan.
return: Int arguments: object
initialDurationUnit: object: Unit of initial duration of the Plan.
return: String arguments: object
kind: object: Kind of the Plan.
return: String arguments: object
lastActivationDate: object: Last date when a learner can activate their access
return: ISO8601Date arguments: object
licenseCount: object: Number of associated licenses
return: Int arguments: object
name: object: Name of the BasePlanInterface.
return: String arguments: object
planType: object: Type of the Plan.
return: String arguments: object
seatCount: object: Number of seats
return: Int arguments: object
seatCountType: object: Type of the seating
return: String arguments: object
slug: object: Slug of the Plan used to generate purchase and voucher URL.
return: String arguments: object
usedSeatCount: object: Number of seats used
return: Int arguments: object
validFrom: object: Date from which BasePlanInterface is valid
return: ISO8601Date arguments: object
validTo: object: Date until which BasePlanInterface is valid
return: ISO8601Date arguments: object

Example

{
  "accessExpirationDate": {
    "return": "object",
    "arguments": {}
  },
  "activatedLicenseCount": {
    "return": "number",
    "arguments": {}
  },
  "activeLicenseCount": {
    "return": "number",
    "arguments": {}
  },
  "availableSeatCount": {
    "return": "number",
    "arguments": {}
  },
  "contentPackages": {
    "return": [
      {
        "bannerImageUrl": {
          "return": "string",
          "arguments": {}
        },
        "collaboratorEmails": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "courseType": {
          "return": "string",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "enrollmentsCount": {
          "return": "number",
          "arguments": {}
        },
        "featureAccesses": {
          "return": [
            {
              "allowed": {
                "return": "boolean",
                "arguments": {}
              },
              "description": {
                "return": "string",
                "arguments": {}
              },
              "featureConfiguration": {
                "return": {
                  "configuration": {
                    "return": "object",
                    "arguments": {}
                  },
                  "configurationTypesJson": {
                    "return": "object",
                    "arguments": {}
                  },
                  "controllableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "controllableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "featureId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "slug": {
                    "return": "string",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "group": {
                "return": "string",
                "arguments": {}
              },
              "manageable": {
                "return": "boolean",
                "arguments": {}
              },
              "managedByControllableTypes": {
                "return": [
                  "string"
                ],
                "arguments": {}
              },
              "slug": {
                "return": "string",
                "arguments": {}
              },
              "summary": {}
            }
          ]
        }
      }
    ]
  }
}

PlanConnection: object

The connection type for Plan.

edges: object: A list of edges.
return: PlanEdge arguments: object
nodes: object: A list of nodes.
return: Plan arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "accessExpirationDate": {
              "return": "object",
              "arguments": {}
            },
            "activatedLicenseCount": {
              "return": "number",
              "arguments": {}
            },
            "activeLicenseCount": {
              "return": "number",
              "arguments": {}
            },
            "availableSeatCount": {
              "return": "number",
              "arguments": {}
            },
            "contentPackages": {
              "return": [
                {
                  "bannerImageUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "collaboratorEmails": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  },
                  "courseType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "enrollmentsCount": {
                    "return": "number",
                    "arguments": {}
                  },
                  "featureAccesses": {
                    "return": [
                      {
                        "allowed": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "description": {
                          "return": "string",
                          "arguments": {}
                        },
                        "featureConfiguration": {
                          "return": {
                            "configuration": {
                              "return": "object",
                              "arguments": {}
                            },
                            "configurationTypesJson": {
                              "return": "object",
                              "arguments": {}
                            },
                            "controllableId": {
                              "return": "string",
                              "arguments": {}
                            },
                            "controllableType": {
                              "return": "string",
                              "arguments": {}
                            },
                            "featureId": {
                              "return": "string",
                              "arguments": {}
                            },
                            "slug": {
                              "return": "string",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "group": {
                          "return": "string",
                          "arguments": {}
                        },
                        "manageable": {
                          "return": "boolean"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        }
      }
    ]
  }
}

PlanCreateInput: object

name: String
slug: String
externalId: String
validFrom: String
validTo: String
durationUnit: String
duration: String
finalAccessDate: String
firstActivationDate: ISO8601Date
kind: String
contentPackageIds: ID
planType: String

Example

{
  "name": "string",
  "slug": "string",
  "externalId": "string",
  "validFrom": "string",
  "validTo": "string",
  "durationUnit": "string",
  "duration": "string",
  "finalAccessDate": "string",
  "firstActivationDate": "object",
  "kind": "string",
  "contentPackageIds": [
    "string"
  ],
  "planType": "string"
}

PlanCreateMutationPayload: object

Autogenerated return type of PlanCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
plan: object: Plan resource participating in the mutation.
return: Plan arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "plan": {
    "return": {
      "accessExpirationDate": {
        "return": "object",
        "arguments": {}
      },
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "contentPackages": {
        "return": [
          {
            "bannerImageUrl": {
              "return": "string",
              "arguments": {}
            },
            "collaboratorEmails": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "courseType": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "enrollmentsCount": {
              "return": "number",
              "arguments": {}
            },
            "featureAccesses": {
              "return": [
                {
                  "allowed": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "featureConfiguration": {
                    "return": {
                      "configuration": {
                        "return": "object",
                        "arguments": {}
                      },
                      "configurationTypesJson": {
                        "return": "object",
                        "arguments": {}
                      },
                      "controllableId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "controllableType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "featureId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "slug": {}
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

PlanEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Plan arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "accessExpirationDate": {
        "return": "object",
        "arguments": {}
      },
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "contentPackages": {
        "return": [
          {
            "bannerImageUrl": {
              "return": "string",
              "arguments": {}
            },
            "collaboratorEmails": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "courseType": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "enrollmentsCount": {
              "return": "number",
              "arguments": {}
            },
            "featureAccesses": {
              "return": [
                {
                  "allowed": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "featureConfiguration": {
                    "return": {
                      "configuration": {
                        "return": "object",
                        "arguments": {}
                      },
                      "configurationTypesJson": {
                        "return": "object",
                        "arguments": {}
                      },
                      "controllableId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "controllableType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "featureId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "slug": {
                        "return": "string",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "group": {
                    "return": "string",
                    "arguments": {}
                  },
                  "manageable": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "managedByControllableTypes": {
                    "return": [
                      null
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

PlanFilter: object

Input fields for plan search

ids: ID: Search by IDs
query: String: Smart search across ID, name, and email

Example

{
  "ids": [
    "string"
  ],
  "query": "string"
}

PlanSortAttributes: string

object id: Sort by ID
object external_id: Sort by external ID
object name: Sort by name
object plan_type: Sort by plan type

PlanSortOrderFilter: object

order: SortOrder
by: PlanSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

PlanUpdateAuthorizationsInput: object

id: ID
contentPackageIdsToAdd: ID
contentPackageIdsToRemove: ID

Example

{
  "id": "string",
  "contentPackageIdsToAdd": [
    "string"
  ],
  "contentPackageIdsToRemove": [
    "string"
  ]
}

PlanUpdateAuthorizationsMutationPayload: object

Autogenerated return type of PlanUpdateAuthorizationsMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
plan: object: Plan resource participating in the mutation.
return: Plan arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "plan": {
    "return": {
      "accessExpirationDate": {
        "return": "object",
        "arguments": {}
      },
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "contentPackages": {
        "return": [
          {
            "bannerImageUrl": {
              "return": "string",
              "arguments": {}
            },
            "collaboratorEmails": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "courseType": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "enrollmentsCount": {
              "return": "number",
              "arguments": {}
            },
            "featureAccesses": {
              "return": [
                {
                  "allowed": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "featureConfiguration": {
                    "return": {
                      "configuration": {
                        "return": "object",
                        "arguments": {}
                      },
                      "configurationTypesJson": {
                        "return": "object",
                        "arguments": {}
                      },
                      "controllableId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "controllableType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "featureId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "slug": {}
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

PlanUpdateInput: object

id: ID
name: String
slug: String
externalId: String
validFrom: String
validTo: String
durationUnit: String
duration: Int
finalAccessDate: String
firstActivationDate: String

Example

{
  "id": "string",
  "name": "string",
  "slug": "string",
  "externalId": "string",
  "validFrom": "string",
  "validTo": "string",
  "durationUnit": "string",
  "duration": "number",
  "finalAccessDate": "string",
  "firstActivationDate": "string"
}

PlanUpdateMutationPayload: object

Autogenerated return type of PlanUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
plan: object: Plan resource participating in the mutation.
return: Plan arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "plan": {
    "return": {
      "accessExpirationDate": {
        "return": "object",
        "arguments": {}
      },
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "contentPackages": {
        "return": [
          {
            "bannerImageUrl": {
              "return": "string",
              "arguments": {}
            },
            "collaboratorEmails": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "courseType": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "enrollmentsCount": {
              "return": "number",
              "arguments": {}
            },
            "featureAccesses": {
              "return": [
                {
                  "allowed": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "featureConfiguration": {
                    "return": {
                      "configuration": {
                        "return": "object",
                        "arguments": {}
                      },
                      "configurationTypesJson": {
                        "return": "object",
                        "arguments": {}
                      },
                      "controllableId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "controllableType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "featureId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "slug": {}
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

ProductCategory: object

Represents information about an individual product category.

id: object: ID of the ProductCategory.
return: ID arguments: object
locale: object: Locale of the ProductCategory.
return: String arguments: object
name: object: Name of the ProductCategory.
return: String arguments: object
parentCategoryName: object: Name of the parent category of the ProductCategory.
return: String arguments: object
sortOrder: object: Sort order of the ProductCategory.
return: Int arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "locale": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "parentCategoryName": {
    "return": "string",
    "arguments": {}
  },
  "sortOrder": {
    "return": "number",
    "arguments": {}
  }
}

ProductCategoryAssignment: object

Represents information about an individual product category assignment.

categorizableId: object: ID of the referenced categorizable of the ProductCategoryAssignment.
return: ID arguments: object
categorizableType: object: Type of the referenced categorizable of the ProductCategoryAssignment.
return: String arguments: object
id: object: ID of the ProductCategoryAssignment.
return: ID arguments: object
locale: object: Locale of the referenced ProductCategory
return: String arguments: object
parentProductCategoryName: object: Name of the parent ProductCategory of the ProductCategoryAssignment.
return: ID arguments: object
productCategoryId: object: ID of the ProductCategory of the ProductCategoryAssignment.
return: ID arguments: object
productCategoryName: object: Name of the ProductCategory of the ProductCategoryAssignment.
return: ID arguments: object

Example

{
  "categorizableId": {
    "return": "string",
    "arguments": {}
  },
  "categorizableType": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "locale": {
    "return": "string",
    "arguments": {}
  },
  "parentProductCategoryName": {
    "return": "string",
    "arguments": {}
  },
  "productCategoryId": {
    "return": "string",
    "arguments": {}
  },
  "productCategoryName": {
    "return": "string",
    "arguments": {}
  }
}

ProductCategoryAssignmentConnection: object

The connection type for ProductCategoryAssignment.

edges: object: A list of edges.
return: ProductCategoryAssignmentEdge arguments: object
nodes: object: A list of nodes.
return: ProductCategoryAssignment arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "categorizableId": {
              "return": "string",
              "arguments": {}
            },
            "categorizableType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "locale": {
              "return": "string",
              "arguments": {}
            },
            "parentProductCategoryName": {
              "return": "string",
              "arguments": {}
            },
            "productCategoryId": {
              "return": "string",
              "arguments": {}
            },
            "productCategoryName": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "categorizableId": {
          "return": "string",
          "arguments": {}
        },
        "categorizableType": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "locale": {
          "return": "string",
          "arguments": {}
        },
        "parentProductCategoryName": {
          "return": "string",
          "arguments": {}
        },
        "productCategoryId": {
          "return": "string",
          "arguments": {}
        },
        "productCategoryName": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

ProductCategoryAssignmentEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: ProductCategoryAssignment arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "categorizableId": {
        "return": "string",
        "arguments": {}
      },
      "categorizableType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "locale": {
        "return": "string",
        "arguments": {}
      },
      "parentProductCategoryName": {
        "return": "string",
        "arguments": {}
      },
      "productCategoryId": {
        "return": "string",
        "arguments": {}
      },
      "productCategoryName": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

ProductCategoryAssignmentFilter: object

Input fields for product category assignment search

forCategorizable: String: Search for product category assignments for a specific categorizable record

Example

{
  "forCategorizable": "string"
}

ProductCategoryAssignmentsUpdateInput: object

categorizableId: ID
categorizableType: CategorizableTypeEnum
productCategoryIds: ID

Example

{
  "categorizableId": "string",
  "categorizableType": "string",
  "productCategoryIds": [
    "string"
  ]
}

ProductCategoryAssignmentsUpdateMutationPayload: object

Autogenerated return type of ProductCategoryAssignmentsUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
productCategoryAssignments: object: ProductCategoryAssignment resources created in the mutation.
return: ProductCategoryAssignment arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "productCategoryAssignments": {
    "return": [
      {
        "categorizableId": {
          "return": "string",
          "arguments": {}
        },
        "categorizableType": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "locale": {
          "return": "string",
          "arguments": {}
        },
        "parentProductCategoryName": {
          "return": "string",
          "arguments": {}
        },
        "productCategoryId": {
          "return": "string",
          "arguments": {}
        },
        "productCategoryName": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

ProductCategoryConnection: object

The connection type for ProductCategory.

edges: object: A list of edges.
return: ProductCategoryEdge arguments: object
nodes: object: A list of nodes.
return: ProductCategory arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "locale": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "parentCategoryName": {
              "return": "string",
              "arguments": {}
            },
            "sortOrder": {
              "return": "number",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "locale": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "parentCategoryName": {
          "return": "string",
          "arguments": {}
        },
        "sortOrder": {
          "return": "number",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

ProductCategoryEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: ProductCategory arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "locale": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "parentCategoryName": {
        "return": "string",
        "arguments": {}
      },
      "sortOrder": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

ProductCategoryFilter: object

Input fields for product category search

childOnly: Boolean: Search only for product categories that have a parent

Example

{
  "childOnly": "boolean"
}

ProductCategorySortAttributes: string

object sort_order: Sort by sort order

ProductCategorySortOrderFilter: object

order: SortOrder
by: ProductCategorySortAttributes

Example

{
  "order": "string",
  "by": "string"
}

Recognition: object

Represents information about a Recognition

id: object: ID of the Recognition.
return: ID arguments: object
name: object: Name of the Recognition
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  }
}

RecognitionConnection: object

The connection type for Recognition.

edges: object: A list of edges.
return: RecognitionEdge arguments: object
nodes: object: A list of nodes.
return: Recognition arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

RecognitionEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Recognition arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

RecognitionFilter: object

Input fields for recognition search

ids: ID: Search by IDs
contentPackageId: ID: Search by content package ID

Example

{
  "ids": [
    "string"
  ],
  "contentPackageId": "string"
}

RecognitionSortAttributes: string

object id: Sort by ID
object name: Sort by name

RecognitionSortOrderFilter: object

order: SortOrder
by: RecognitionSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

RecognitionType: object

Represents information about a Recognition Type.

awardType: object: Type of Recognition awarded.
return: RecognitionTypeEnum arguments: object
id: object: ID of the Recognition Type.
return: ID arguments: object
isUsedInCourse: object: Whether the Recognition Type is associated with an Issuance.
return: Boolean arguments: object
name: object: Name of the Recognition Type.
return: String arguments: object

Example

{
  "awardType": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "isUsedInCourse": {
    "return": "boolean",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  }
}

RecognitionTypeConnection: object

The connection type for RecognitionType.

edges: object: A list of edges.
return: RecognitionTypeEdge arguments: object
nodes: object: A list of nodes.
return: RecognitionType arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "awardType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "isUsedInCourse": {
              "return": "boolean",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "awardType": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "isUsedInCourse": {
          "return": "boolean",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

RecognitionTypeCreateInput: object

name: String
awardType: RecognitionTypeEnum

Example

{
  "name": "string",
  "awardType": "string"
}

RecognitionTypeCreateMutationPayload: object

Autogenerated return type of RecognitionTypeCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
recognitionType: object: RecognitionType resource participating in the mutation.
return: RecognitionType arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "recognitionType": {
    "return": {
      "awardType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "isUsedInCourse": {
        "return": "boolean",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

RecognitionTypeDeleteInput: object

id: ID

Example

{
  "id": "string"
}

RecognitionTypeDeleteMutationPayload: object

Autogenerated return type of RecognitionTypeDeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
recognitionType: object: Recognition Type participating in the mutation.
return: RecognitionType arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "recognitionType": {
    "return": {
      "awardType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "isUsedInCourse": {
        "return": "boolean",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

RecognitionTypeEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: RecognitionType arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "awardType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "isUsedInCourse": {
        "return": "boolean",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

RecognitionTypeEnum: string

object credit_unit
object credly

RecognitionTypeFilter: object

Input fields for Recognition Type search

ids: ID: Search by IDs

Example

{
  "ids": [
    "string"
  ]
}

RecognitionTypeSortAttributes: string

object id: Sort by ID
object name: Sort by Name

RecognitionTypeSortOrderFilter: object

order: SortOrder
by: RecognitionTypeSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

RecognitionTypeUpdateInput: object

id: ID
name: String

Example

{
  "id": "string",
  "name": "string"
}

RecognitionTypeUpdateMutationPayload: object

Autogenerated return type of RecognitionTypeUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
recognitionType: object: RecognitionType resource participating in the mutation.
return: RecognitionType arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "recognitionType": {
    "return": {
      "awardType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "isUsedInCourse": {
        "return": "boolean",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

RecordError: object

Documents an error that occurred while update a record.

message: object: Description of the RecordError.
return: String arguments: object
path: object: Associated input value of the RecordError.
return: String arguments: object

Example

{
  "message": {
    "return": "string",
    "arguments": {}
  },
  "path": {
    "return": [
      "string"
    ],
    "arguments": {}
  }
}

Role: object

A set of Permissions assignable to a User

accessContexts: object: Array of access context this role contains
return: AccessContextEnum arguments: object
description: object: Description of the Role.
return: String arguments: object
editable: object: Indicates if the Role can be edited.
return: Boolean arguments: object
id: object: ID of the Role.
return: ID arguments: object
name: object: Name of the Role.
return: String arguments: object
permissionBased: object: Indicates if Role's authorization is based on permissions.
return: Boolean arguments: object
permissions: object: Permissions (resolver) available to the Role.
return: Permission arguments: object
slug: object: Slug of the Role.
return: String arguments: object
updatedAt: object: Timestamp when the Role was last updated.
return: ISO8601DateTime arguments: object

Example

{
  "accessContexts": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "description": {
    "return": "string",
    "arguments": {}
  },
  "editable": {
    "return": "boolean",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "permissionBased": {
    "return": "boolean",
    "arguments": {}
  },
  "permissions": {
    "return": [
      {
        "accessContexts": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "action": {
          "return": "string",
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "resource": {
          "return": "string",
          "arguments": {}
        },
        "slug": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "slug": {
    "return": "string",
    "arguments": {}
  },
  "updatedAt": {
    "return": "object",
    "arguments": {}
  }
}

RoleConnection: object

The connection type for Role.

edges: object: A list of edges.
return: RoleEdge arguments: object
nodes: object: A list of nodes.
return: Role arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "accessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "editable": {
              "return": "boolean",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "permissionBased": {
              "return": "boolean",
              "arguments": {}
            },
            "permissions": {
              "return": [
                {
                  "accessContexts": {
                    "return": [
                      "string"
                    ],
                    "arguments": {}
                  },
                  "action": {
                    "return": "string",
                    "arguments": {}
                  },
                  "description": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "resource": {
                    "return": "string",
                    "arguments": {}
                  },
                  "slug": {
                    "return": "string",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            },
            "updatedAt": {
              "return": "object",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "accessContexts": {
          "return": [
            "string"
          ],
          "arguments": {}
        },
        "description": {
          "return": "string",
          "arguments": {}
        },
        "editable": {
          "return": "boolean",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {}
      }
    ]
  }
}

RoleCreateInput: object

slug: String
name: String
permissionSlugs: String: Assignable Permissions: access:blueprint,access:console,activate:users,create:communications,create:licenses,create:materials,create:plans,create:subscriptions,create:users,create:user_roles,create:vouchers,deactivate:users,delete:communications,delete:materials,delete:user_roles,grade:assignments,impersonate:users,manage:assignments,manage:branding,manage:custom_urls,manage:product_categories,read:activities,read:communications,read:content,read:content_packages,read:enrollments,read:licenses,read:login_trackings,read:materials,read:permissions,read:plans,read:product_categories,read:reports,read:resources,read:roles,read:subscriptions,read:users,read:user_roles,read:vouchers,remove:licenses,reset:activities,reset:enrollments,update:communications,update:content_packages,update:enrollments,update:learning_hub,update:licenses,update:materials,update:plans,update:tenants,update:users,update:user_roles,update:vouchers,create:developer_tokens (if developer_tools feature access enabled),create:webhooks (if developer_tools feature access enabled),read:developer_tokens (if developer_tools feature access enabled),read:webhooks (if developer_tools feature access enabled),update:developer_tokens (if developer_tools feature access enabled),update:webhooks (if developer_tools feature access enabled),create:branches (if branches feature access enabled),delete:branches (if branches feature access enabled),read:branches (if branches feature access enabled),update:branches (if branches feature access enabled),read:branch_plans (if branches feature access enabled),update:branch_plans (if branches feature access enabled),create:branch_plans (if branches feature access enabled),read:groups (if branches feature access enabled),update:groups (if branches feature access enabled),create:groups (if branches feature access enabled),read:psychometric_dashboard (if psychometric_and_usage_dashboards feature access enabled),read:usage_dashboard (if psychometric_and_usage_dashboards feature access enabled),create:curriculums (if curriculum feature access enabled),read:curriculums (if curriculum feature access enabled),update:curriculums (if curriculum feature access enabled),delete:curriculums (if curriculum feature access enabled),create:lti (if lti_tools feature access enabled),read:lti (if lti_tools feature access enabled),update:lti (if lti_tools feature access enabled),delete:lti (if lti_tools feature access enabled),create:recognition_types (if recognition_issuance feature access enabled),read:recognition_types (if recognition_issuance feature access enabled),update:recognition_types (if recognition_issuance feature access enabled),delete:recognition_types (if recognition_issuance feature access enabled)
description: String

Example

{
  "slug": "string",
  "name": "string",
  "permissionSlugs": [
    "string"
  ],
  "description": "string"
}

RoleCreateMutationPayload: object

Autogenerated return type of RoleCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
role: object: Role resource participating in the mutation.
return: Role arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "role": {
    "return": {
      "accessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "editable": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "permissionBased": {
        "return": "boolean",
        "arguments": {}
      },
      "permissions": {
        "return": [
          {
            "accessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "action": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "resource": {
              "return": "string",
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

RoleDeleteMutationInput: object

Autogenerated input type of RoleDeleteMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

RoleDeleteMutationPayload: object

Autogenerated return type of RoleDeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
role: object: Role resource participating in the mutation.
return: Role arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "role": {
    "return": {
      "accessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "editable": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "permissionBased": {
        "return": "boolean",
        "arguments": {}
      },
      "permissions": {
        "return": [
          {
            "accessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "action": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "resource": {
              "return": "string",
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

RoleEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Role arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "accessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "editable": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "permissionBased": {
        "return": "boolean",
        "arguments": {}
      },
      "permissions": {
        "return": [
          {
            "accessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "action": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "resource": {
              "return": "string",
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

RoleFilter: object

Input fields for role search

ids: ID: Search by IDs
notSlugs: String: Exclude Roles with provided slugs
query: String: Smart search by name
accessContexts: AccessContextEnum: Search by permissions access contexts

Example

{
  "ids": [
    "string"
  ],
  "notSlugs": [
    "string"
  ],
  "query": "string",
  "accessContexts": [
    "string"
  ]
}

RoleSortAttributes: string

object name: Sort by name
object slug: Sort by slug
object editable: Sort by whether the role is editable
object updated_at: Sort by last updated at timestamp

RoleSortOrderFilter: object

order: SortOrder
by: RoleSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

RoleUpdateInput: object

id: ID
name: String
description: String
permissionSlugs: String: Assignable Permissions: access:blueprint,access:console,activate:users,create:communications,create:licenses,create:materials,create:plans,create:subscriptions,create:users,create:user_roles,create:vouchers,deactivate:users,delete:communications,delete:materials,delete:user_roles,grade:assignments,impersonate:users,manage:assignments,manage:branding,manage:custom_urls,manage:product_categories,read:activities,read:communications,read:content,read:content_packages,read:enrollments,read:licenses,read:login_trackings,read:materials,read:permissions,read:plans,read:product_categories,read:reports,read:resources,read:roles,read:subscriptions,read:users,read:user_roles,read:vouchers,remove:licenses,reset:activities,reset:enrollments,update:communications,update:content_packages,update:enrollments,update:learning_hub,update:licenses,update:materials,update:plans,update:tenants,update:users,update:user_roles,update:vouchers,create:developer_tokens (if developer_tools feature access enabled),create:webhooks (if developer_tools feature access enabled),read:developer_tokens (if developer_tools feature access enabled),read:webhooks (if developer_tools feature access enabled),update:developer_tokens (if developer_tools feature access enabled),update:webhooks (if developer_tools feature access enabled),create:branches (if branches feature access enabled),delete:branches (if branches feature access enabled),read:branches (if branches feature access enabled),update:branches (if branches feature access enabled),read:branch_plans (if branches feature access enabled),update:branch_plans (if branches feature access enabled),create:branch_plans (if branches feature access enabled),read:groups (if branches feature access enabled),update:groups (if branches feature access enabled),create:groups (if branches feature access enabled),read:psychometric_dashboard (if psychometric_and_usage_dashboards feature access enabled),read:usage_dashboard (if psychometric_and_usage_dashboards feature access enabled),create:curriculums (if curriculum feature access enabled),read:curriculums (if curriculum feature access enabled),update:curriculums (if curriculum feature access enabled),delete:curriculums (if curriculum feature access enabled),create:lti (if lti_tools feature access enabled),read:lti (if lti_tools feature access enabled),update:lti (if lti_tools feature access enabled),delete:lti (if lti_tools feature access enabled),create:recognition_types (if recognition_issuance feature access enabled),read:recognition_types (if recognition_issuance feature access enabled),update:recognition_types (if recognition_issuance feature access enabled),delete:recognition_types (if recognition_issuance feature access enabled)

Example

{
  "id": "string",
  "name": "string",
  "description": "string",
  "permissionSlugs": [
    "string"
  ]
}

RoleUpdateMutationPayload: object

Autogenerated return type of RoleUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
role: object: Role resource participating in the mutation.
return: Role arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "role": {
    "return": {
      "accessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "editable": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "permissionBased": {
        "return": "boolean",
        "arguments": {}
      },
      "permissions": {
        "return": [
          {
            "accessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "action": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "resource": {
              "return": "string",
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

SeatCountTypeEnum: string

object infinite_seat
object limited_seat

SortOrder: string

Sort direction Enums

object asc: Sort records in ascending order by the specified attributes
object desc: Sort records in descending order by the specified attributes

StateEnum: string

object inactive
object active
object removed

StateTypeEnum: string

object Disabled
object Pending
object Expired
object Active

StatusEnum: string

object inactive
object active
object expired

String: string

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

StudyTask: object

Represents information about a StudyTask

id: object: ID of the StudyTask.
return: ID arguments: object
name: object: Name of the StudyTask.
return: String arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  }
}

StudyTaskConnection: object

The connection type for StudyTask.

edges: object: A list of edges.
return: StudyTaskEdge arguments: object
nodes: object: A list of nodes.
return: StudyTask arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

StudyTaskEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: StudyTask arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

StudyTaskFilter: object

Input fields for study task search

ids: ID: Search by IDs
contentPackageId: ID: Search by content package ID

Example

{
  "ids": [
    "string"
  ],
  "contentPackageId": "string"
}

StudyTaskSortAttributes: string

object id: Sort by ID
object name: Sort by name

StudyTaskSortOrderFilter: object

order: SortOrder
by: StudyTaskSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

Subscription: object

Represents information about a subscription to a plan.

createdAt: object: Timestamp when the Subscription was created.
return: ISO8601DateTime arguments: object
id: object: ID of the Subscription.
return: ID arguments: object
license: object: License (resolver) associated with the Subscription.
return: License arguments: object
user: object: User (resolver) associated with the Subscription.
return: User arguments: object
voucher: object: Voucher (resolver) associated with the Subscription.
return: Voucher arguments: object

Example

{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "license": {
    "return": {
      "activatedAt": {
        "return": "object",
        "arguments": {}
      },
      "branchPlan": {
        "return": {
          "activatedLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "activeLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "availableSeatCount": {
            "return": "number",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

SubscriptionConnection: object

The connection type for Subscription.

edges: object: A list of edges.
return: SubscriptionEdge arguments: object
nodes: object: A list of nodes.
return: Subscription arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "license": {
              "return": {
                "activatedAt": {
                  "return": "object",
                  "arguments": {}
                },
                "branchPlan": {
                  "return": {
                    "activatedLicenseCount": {
                      "return": "number",
                      "arguments": {}
                    },
                    "activeLicenseCount": {
                      "return": "number",
                      "arguments": {}
                    },
                    "availableSeatCount": {
                      "return": "number",
                      "arguments": {}
                    },
                    "branch": {
                      "return": {
                        "appliedBranding": {
                          "return": {
                            "brandableId": {
                              "return": "string",
                              "arguments": {}
                            },
                            "brandableType": {
                              "return": "string",
                              "arguments": {}
                            },
                            "colorLogoUrl": {
                              "return": "string",
                              "arguments": {}
                            },
                            "emailLogoUrl": {
                              "return": "string",
                              "arguments": {}
                            },
                            "faviconUrl": {
                              "return": "string",
                              "arguments": {}
                            },
                            "footer": {
                              "return": {
                                "html": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "id": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "isDefault": {
                                  "return": "boolean",
                                  "arguments": {}
                                },
                                "variables": {
                                  "return": "object",
                                  "arguments": {}
                                }
                              },
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "marketingPage": {
                              "return": {
                                "html": {
                                  "return": "string",
                                  "arguments": {}
                                },
                                "id": {}
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

SubscriptionCreateInput: object

userId: ID
voucherToken: String

Example

{
  "userId": "string",
  "voucherToken": "string"
}

SubscriptionCreateMutationPayload: object

Autogenerated return type of SubscriptionCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
subscription: object: Subscription resource participating in the mutation.
return: Subscription arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "subscription": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "license": {
        "return": {
          "activatedAt": {
            "return": "object",
            "arguments": {}
          },
          "branchPlan": {
            "return": {
              "activatedLicenseCount": {
                "return": "number",
                "arguments": {}
              },
              "activeLicenseCount": {
                "return": "number",
                "arguments": {}
              },
              "availableSeatCount": {
                "return": "number",
                "arguments": {}
              },
              "branch": {
                "return": {
                  "appliedBranding": {
                    "return": {
                      "brandableId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "brandableType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "colorLogoUrl": {
                        "return": "string",
                        "arguments": {}
                      },
                      "emailLogoUrl": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconUrl": {
                        "return": "string",
                        "arguments": {}
                      },
                      "footer": {
                        "return": {
                          "html": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "string",
                            "arguments": {}
                          },
                          "isDefault": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "variables": {
                            "return": "object",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "id": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

SubscriptionEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Subscription arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "license": {
        "return": {
          "activatedAt": {
            "return": "object",
            "arguments": {}
          },
          "branchPlan": {
            "return": {
              "activatedLicenseCount": {
                "return": "number",
                "arguments": {}
              },
              "activeLicenseCount": {
                "return": "number",
                "arguments": {}
              },
              "availableSeatCount": {
                "return": "number",
                "arguments": {}
              },
              "branch": {
                "return": {
                  "appliedBranding": {
                    "return": {
                      "brandableId": {
                        "return": "string",
                        "arguments": {}
                      },
                      "brandableType": {
                        "return": "string",
                        "arguments": {}
                      },
                      "colorLogoUrl": {
                        "return": "string",
                        "arguments": {}
                      },
                      "emailLogoUrl": {
                        "return": "string",
                        "arguments": {}
                      },
                      "faviconUrl": {
                        "return": "string",
                        "arguments": {}
                      },
                      "footer": {
                        "return": {
                          "html": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "string",
                            "arguments": {}
                          },
                          "isDefault": {
                            "return": "boolean",
                            "arguments": {}
                          },
                          "variables": {
                            "return": "object",
                            "arguments": {}
                          }
                        },
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "marketingPage": {
                        "return": {
                          "html": {
                            "return": "string",
                            "arguments": {}
                          },
                          "id": {
                            "return": "string",
                            "arguments": {}
                          },
                          "isDefault": {}
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

SubscriptionFilter: object

Input fields for subscription search

planIds: ID: Search by plan ID
userQuery: String: Smart search across user ID, name, and email

Example

{
  "planIds": [
    "string"
  ],
  "userQuery": "string"
}

SubscriptionSortAttributes: string

object created_at: Sort by time created
object license_id: Sort by license ID
object license_state: Sort by status of the license
object user_email: Sort by user email
object user_id: Sort by user ID
object user_name: Sort by user name
object user_sis_id: Sort by user SIS ID
object voucher_token: Sort by voucher token

SubscriptionSortOrderFilter: object

order: SortOrder
by: SubscriptionSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

UploadDataFormatEnum: string

object json
object csv

UploadGroupInput: object

name: String
branchSlug: String
externalId: String
description: String

Example

{
  "name": "string",
  "branchSlug": "string",
  "externalId": "string",
  "description": "string"
}

UploadUserInput: object

name: String
email: String
password: String
sisId: String

Example

{
  "name": "string",
  "email": "string",
  "password": "string",
  "sisId": "string"
}

User: object

Represents information about a user of the platform

authenticationProvider: object: The name of the authentication or Identity Provider for the User.
return: String arguments: object
branch: object: Branch (resolver) associated with the User.
return: Branch arguments: object
branchMembershipGuard: object: Indicates why the user's membership cannot be transferred to a new branch. If the user can be transferred, then this field returns null.
return: UserBranchMembershipGuardErrorEnum arguments: object
createdAt: object: Timestamp when the User was created.
return: ISO8601DateTime arguments: object
email: object: Email address of the User.
return: String arguments: object
enrollments: object: A paginated list of Enrollments (resolver) of the User.
return: EnrollmentAssociationConnection arguments: object offset: Int The index of the first item in the records to be returned limit: Int 25 The maximum number of records to be returned sort: EnrollmentSortOrderFilter after: String Returns the elements in the list that come after the specified cursor. before: String Returns the elements in the list that come before the specified cursor. first: Int Returns the first n elements from the list. last: Int Returns the last n elements from the list.
extendedTimeAccommodation: object: Determines if the User has Extended Time Accommodations enabled.
return: Boolean arguments: object
groups: object: A paginated list of Groups (resolver) of the User.
return: Group arguments: object
id: object: ID of the User.
return: ID arguments: object
identifier: object: An ID for the user which may come from sis_id, SSO ID, Identity UUID, etc.
return: String arguments: object
impersonatable: object: Indicates if this User can be impersonated by the CurrentUser.
return: Boolean arguments: object
isSsoUser: object: Indicates if the User is an SSO User.
return: Boolean arguments: object
lastLoginAt: object: Timestamp when the User last logged in.
return: ISO8601DateTime arguments: object
licenses: object: A paginated list of Licenses (resolver) of the User.
return: LicenseAssociationConnection arguments: object offset: Int The index of the first item in the records to be returned limit: Int 25 The maximum number of records to be returned sort: LicenseSortOrderFilter after: String Returns the elements in the list that come after the specified cursor. before: String Returns the elements in the list that come before the specified cursor. first: Int Returns the first n elements from the list. last: Int Returns the last n elements from the list.
loginTrackings: object: A paginated list of LoginTrackings (resolver) of the User.
return: LoginTrackingAssociationConnection arguments: object offset: Int The index of the first item in the records to be returned limit: Int 25 The maximum number of records to be returned sort: LoginTrackingSortOrderFilter after: String Returns the elements in the list that come after the specified cursor. before: String Returns the elements in the list that come before the specified cursor. first: Int Returns the first n elements from the list. last: Int Returns the last n elements from the list.
name: object: Name of the User.
return: String arguments: object
sisId: object: An external System ID of the User.
return: String arguments: object
state: object: Active/inactive status of the User's account.
return: String arguments: object
userRoles: object: A paginated list of UserRoles (resolver) of the User.
return: UserRole arguments: object

Example

{
  "authenticationProvider": {
    "return": "string",
    "arguments": {}
  },
  "branch": {
    "return": {
      "appliedBranding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {
            "return": "string",
            "arguments": {}
          },
          "colorLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "emailLogoUrl": {
            "return": "string",
            "arguments": {}
          },
          "faviconUrl": {
            "return": "string",
            "arguments": {}
          },
          "footer": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "marketingPage": {
            "return": {
              "html": {
                "return": "string",
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "isDefault": {
                "return": "boolean",
                "arguments": {}
              },
              "variables": {
                "return": "object",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "mobileIconUrl": {
            "return": "string",
            "arguments": {}
          },
          "primaryColor": {
            "return": "string",
            "arguments": {}
          },
          "secondaryColor": {
            "return": "string",
            "arguments": {}
          },
          "whiteLogoUrl": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "branding": {
        "return": {
          "brandableId": {
            "return": "string",
            "arguments": {}
          },
          "brandableType": {}
        }
      }
    }
  }
}

UserActivateMutationInput: object

Autogenerated input type of UserActivateMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

UserActivateMutationPayload: object

Autogenerated return type of UserActivateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

UserBranchMembershipGuardErrorEnum: string

object has_group_membership: This user is a member of one or more groups, and cannot be assigned to a new branch or moved from their current branch.

UserConfirmationStatus: string

The user's valid confirmation states

object confirmed: Confirmed by password
object unconfirmed: Not confirmed by password

UserConnection: object

The connection type for User.

edges: object: A list of edges.
return: UserEdge arguments: object
nodes: object: A list of nodes.
return: User arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "authenticationProvider": {
              "return": "string",
              "arguments": {}
            },
            "branch": {
              "return": {
                "appliedBranding": {
                  "return": {
                    "brandableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "brandableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "colorLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "emailLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "footer": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "marketingPage": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "mobileIconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "primaryColor": {
                      "return": "string",
                      "arguments": {}
                    },
                    "secondaryColor": {
                      "return": "string",
                      "arguments": {}
                    },
                    "whiteLogoUrl": {}
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

UserCreateInput: object

name: String
email: String
sisId: String
password: String
passwordConfirmation: String

Example

{
  "name": "string",
  "email": "string",
  "sisId": "string",
  "password": "string",
  "passwordConfirmation": "string"
}

UserCreateMutationPayload: object

Autogenerated return type of UserCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
user: object: User resource participating in the mutation.
return: User arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "user": {
    "return": {
      "authenticationProvider": {
        "return": "string",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

UserDeactivateMutationInput: object

Autogenerated input type of UserDeactivateMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

UserDeactivateMutationPayload: object

Autogenerated return type of UserDeactivateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

UserEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: User arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "authenticationProvider": {
        "return": "string",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {
                "return": "string",
                "arguments": {}
              },
              "whiteLogoUrl": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "branding": {}
        }
      }
    }
  }
}

UserExternalPackage: object

Represents information about a user's enrollment in an External Package.

id: object: ID of the User External Package.
return: ID arguments: object
user: object: User (resolver) associated with the User External Package.
return: User arguments: object

Example

{
  "id": {
    "return": "string",
    "arguments": {}
  },
  "user": {
    "return": {
      "authenticationProvider": {
        "return": "string",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {
                "return": "string",
                "arguments": {}
              },
              "whiteLogoUrl": {
                "return": "string",
                "arguments": {}
              }
            },
            "arguments": {}
          },
          "branding": {}
        }
      }
    }
  }
}

UserExternalPackageConnection: object

The connection type for UserExternalPackage.

edges: object: A list of edges.
return: UserExternalPackageTypeEdge arguments: object
nodes: object: A list of nodes.
return: UserExternalPackage arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "user": {
              "return": {
                "authenticationProvider": {
                  "return": "string",
                  "arguments": {}
                },
                "branch": {
                  "return": {
                    "appliedBranding": {
                      "return": {
                        "brandableId": {
                          "return": "string",
                          "arguments": {}
                        },
                        "brandableType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "colorLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "emailLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "footer": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "isDefault": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "variables": {
                              "return": "object",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "marketingPage": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "isDefault": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "variables": {
                              "return": "object",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "mobileIconUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "primaryColor": {
                          "return": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

UserExternalPackageFilter: object

Input fields for user external package search

externalPackageId: String: Search by external_package_id
query: String: Smart search across ID, name, and email

Example

{
  "externalPackageId": "string",
  "query": "string"
}

UserExternalPackageSortAttributes: string

object user_id: Sort by User ID
object user_status: Sort by status
object user_sis_id: Sort by User SIS ID

UserExternalPackageSortOrderFilter: object

order: SortOrder
by: UserExternalPackageSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

UserExternalPackageTypeEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: UserExternalPackage arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "id": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "authenticationProvider": {
            "return": "string",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "mobileIconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "primaryColor": {
                    "return": "string",
                    "arguments": {}
                  },
                  "secondaryColor": {
                    "return": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

UserFilter: object

Input fields for user search

ids: ID: Search by IDs
excludedIds: ID: Exclude users that match IDs
email: String: Search by email
name: String: Search by name
query: String: Smart search across ID, SIS ID, name, and email
branchId: ID: Search by branch_id
withoutBranch: Boolean: Search only for users without a branch
roleSlug: String: Search by role
withoutRole: Boolean: Search only for users without a role
withoutBranchPlanLicense: ID: Search only for users who do not have an active or pending License for the specified BranchPlan
confirmationStatus: UserConfirmationStatus: Search by confirmation status
managersBranchId: ID: Search Managers by Branch ID
groupId: ID: Search members by Group ID
managersGroupId: ID: Search Managers by Group ID

Example

{
  "ids": [
    "string"
  ],
  "excludedIds": [
    "string"
  ],
  "email": "string",
  "name": "string",
  "query": "string",
  "branchId": "string",
  "withoutBranch": "boolean",
  "roleSlug": "string",
  "withoutRole": "boolean",
  "withoutBranchPlanLicense": "string",
  "confirmationStatus": "string",
  "managersBranchId": "string",
  "groupId": "string",
  "managersGroupId": "string"
}

UserRecognition: object

Represents information about a user recognition

completedAt: object: Timestamp when the user recognition was earned.
return: ISO8601DateTime arguments: object
contentPackageId: object: ID of the content package associated with the earned user recognition.
return: ID arguments: object
contentPackageTitle: object: Title of the content package associated with the earned user recognition.
return: String arguments: object
id: object: ID of the user recognition.
return: ID arguments: object
name: object: Name of the user recognition.
return: String arguments: object
recognitions: object: Information about the recognitions earned by user.
return: Award arguments: object

Example

{
  "completedAt": {
    "return": "object",
    "arguments": {}
  },
  "contentPackageId": {
    "return": "string",
    "arguments": {}
  },
  "contentPackageTitle": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "recognitions": {
    "return": [
      {
        "type": {
          "return": "string",
          "arguments": {}
        },
        "value": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  }
}

UserRecognitionConnection: object

The connection type for UserRecognition.

edges: object: A list of edges.
return: UserRecognitionEdge arguments: object
nodes: object: A list of nodes.
return: UserRecognition arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "completedAt": {
              "return": "object",
              "arguments": {}
            },
            "contentPackageId": {
              "return": "string",
              "arguments": {}
            },
            "contentPackageTitle": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "recognitions": {
              "return": [
                {
                  "type": {
                    "return": "string",
                    "arguments": {}
                  },
                  "value": {
                    "return": "string",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "completedAt": {
          "return": "object",
          "arguments": {}
        },
        "contentPackageId": {
          "return": "string",
          "arguments": {}
        },
        "contentPackageTitle": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "recognitions": {
          "return": [
            {
              "type": {
                "return": "string",
                "arguments": {}
              },
              "value": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      }
    }
  }
}

UserRecognitionEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: UserRecognition arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "completedAt": {
        "return": "object",
        "arguments": {}
      },
      "contentPackageId": {
        "return": "string",
        "arguments": {}
      },
      "contentPackageTitle": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "recognitions": {
        "return": [
          {
            "type": {
              "return": "string",
              "arguments": {}
            },
            "value": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

UserRecognitionFilter: object

Input fields for user recognition search

ids: ID: Search by IDs
userId: ID: Search by user ID
contentPackageId: ID: Search by content package ID
query: String: Search by user recognition name or id

Example

{
  "ids": [
    "string"
  ],
  "userId": "string",
  "contentPackageId": "string",
  "query": "string"
}

UserRecognitionSortAttributes: string

object id: Sort by ID
object name: Sort by recognition name
object content_package_id: Sort by content package id
object content_package_title: Sort by content package title
object completed_at: Sort by time user recognition was earned

UserRecognitionSortOrderFilter: object

order: SortOrder
by: UserRecognitionSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

UserRemoveGroupsInput: object

id: ID

Example

{
  "id": "string"
}

UserRemoveGroupsMutationPayload: object

Autogenerated return type of UserRemoveGroupsMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

UserRole: object

accessContext: object: The AccessContext associated to the CurrentUser's UserRole
return: AccessContext arguments: object
accessContextId: object: Access context ID of the UserRole.
return: ID arguments: object
accessContextType: object: Access context type of the UserRole.
return: String arguments: object
applicableAccessContexts: object: Array of scopes to which the UserRole can be applied.
return: AccessContextEnum arguments: object
id: object: ID of the UserRole.
return: ID arguments: object
properties: object: Set of configuration values for the specific user role
return: JSON arguments: object
role: object: Role (resolver) associated with UserRole.
return: Role arguments: object
roleSlug: object: Role slug of the UserRole.
return: String arguments: object
user: object: User (resolver) associated with UserRole.
return: User arguments: object
userId: object: User ID for the UserRole.
return: String arguments: object

Example

{
  "accessContext": {
    "arguments": {}
  },
  "accessContextId": {
    "return": "string",
    "arguments": {}
  },
  "accessContextType": {
    "return": "string",
    "arguments": {}
  },
  "applicableAccessContexts": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "properties": {
    "return": "object",
    "arguments": {}
  },
  "role": {
    "return": {
      "accessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "description": {
        "return": "string",
        "arguments": {}
      },
      "editable": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "permissionBased": {
        "return": "boolean",
        "arguments": {}
      },
      "permissions": {
        "return": [
          {
            "accessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "action": {
              "return": "string",
              "arguments": {}
            },
            "description": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "resource": {
              "return": "string",
              "arguments": {}
            },
            "slug": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "slug": {
        "return": "string",
        "arguments": {}
      },
      "updatedAt": {
        "return": "object",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "roleSlug": {
    "return": "string",
    "arguments": {}
  },
  "user": {
    "return": {}
  }
}

UserRoleConnection: object

The connection type for UserRole.

edges: object: A list of edges.
return: UserRoleEdge arguments: object
nodes: object: A list of nodes.
return: UserRole arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "accessContext": {
              "arguments": {}
            },
            "accessContextId": {
              "return": "string",
              "arguments": {}
            },
            "accessContextType": {
              "return": "string",
              "arguments": {}
            },
            "applicableAccessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "properties": {
              "return": "object",
              "arguments": {}
            },
            "role": {
              "return": {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "editable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "permissionBased": {
                  "return": "boolean",
                  "arguments": {}
                },
                "permissions": {
                  "return": [
                    {
                      "accessContexts": {
                        "return": [
                          "string"
                        ],
                        "arguments": {}
                      },
                      "action": {
                        "return": "string",
                        "arguments": {}
                      },
                      "description": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "resource": {
                        "return": "string",
                        "arguments": {}
                      },
                      "slug": {
                        "return": "string",
                        "arguments": {}
                      }
                    }
                  ],
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                },
                "updatedAt": {}
              }
            }
          }
        }
      }
    ]
  }
}

UserRoleCreateInput: object

userId: ID
roleSlug: String
accessContextType: AccessContextEnum
accessContextId: ID

Example

{
  "userId": "string",
  "roleSlug": "string",
  "accessContextType": "string",
  "accessContextId": "string"
}

UserRoleCreateMutationPayload: object

Autogenerated return type of UserRoleCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
creationGuard: object: Message describing details of the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
userRole: object: UserRole resource participating in the mutation.
return: UserRole arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "creationGuard": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "userRole": {
    "return": {
      "accessContext": {
        "arguments": {}
      },
      "accessContextId": {
        "return": "string",
        "arguments": {}
      },
      "accessContextType": {
        "return": "string",
        "arguments": {}
      },
      "applicableAccessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "properties": {
        "return": "object",
        "arguments": {}
      },
      "role": {
        "return": {
          "accessContexts": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "editable": {
            "return": "boolean",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "permissionBased": {
            "return": "boolean",
            "arguments": {}
          },
          "permissions": {
            "return": [
              {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "action": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ]
          }
        }
      }
    }
  }
}

UserRoleDeleteMutationInput: object

Autogenerated input type of UserRoleDeleteMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

UserRoleDeleteMutationPayload: object

Autogenerated return type of UserRoleDeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
userRole: object: UserRole resource participating in the mutation.
return: UserRole arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "userRole": {
    "return": {
      "accessContext": {
        "arguments": {}
      },
      "accessContextId": {
        "return": "string",
        "arguments": {}
      },
      "accessContextType": {
        "return": "string",
        "arguments": {}
      },
      "applicableAccessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "properties": {
        "return": "object",
        "arguments": {}
      },
      "role": {
        "return": {
          "accessContexts": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "editable": {
            "return": "boolean",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "permissionBased": {
            "return": "boolean",
            "arguments": {}
          },
          "permissions": {
            "return": [
              {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "action": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ]
          }
        }
      }
    }
  }
}

UserRoleEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: UserRole arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "accessContext": {
        "arguments": {}
      },
      "accessContextId": {
        "return": "string",
        "arguments": {}
      },
      "accessContextType": {
        "return": "string",
        "arguments": {}
      },
      "applicableAccessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "properties": {
        "return": "object",
        "arguments": {}
      },
      "role": {
        "return": {
          "accessContexts": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "editable": {
            "return": "boolean",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "permissionBased": {
            "return": "boolean",
            "arguments": {}
          },
          "permissions": {
            "return": [
              {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "action": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "resource": {
                  "return": "string",
                  "arguments": {}
                },
                "slug": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ],
            "arguments": {}
          },
          "slug": {
            "return": "string",
            "arguments": {}
          },
          "updatedAt": {
            "return": "object",
            "arguments": {}
          }
        },
        "arguments": {}
      }
    }
  }
}

UserRoleFilter: object

Input fields for user role search

userId: ID: Search by User ID
containedUserIds: ID: Search by User IDs for User Roles contained by the Current User Role

Example

{
  "userId": "string",
  "containedUserIds": [
    "string"
  ]
}

UserRoleUpdateInput: object

id: ID
properties: JSON

Example

{
  "id": "string",
  "properties": "object"
}

UserRoleUpdateMutationPayload: object

Autogenerated return type of UserRoleUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
userRole: object: Contains the mutated UserRole resource.
return: UserRole arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "userRole": {
    "return": {
      "accessContext": {
        "arguments": {}
      },
      "accessContextId": {
        "return": "string",
        "arguments": {}
      },
      "accessContextType": {
        "return": "string",
        "arguments": {}
      },
      "applicableAccessContexts": {
        "return": [
          "string"
        ],
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "properties": {
        "return": "object",
        "arguments": {}
      },
      "role": {
        "return": {
          "accessContexts": {
            "return": [
              "string"
            ],
            "arguments": {}
          },
          "description": {
            "return": "string",
            "arguments": {}
          },
          "editable": {
            "return": "boolean",
            "arguments": {}
          },
          "id": {
            "return": "string",
            "arguments": {}
          },
          "name": {
            "return": "string",
            "arguments": {}
          },
          "permissionBased": {
            "return": "boolean",
            "arguments": {}
          },
          "permissions": {
            "return": [
              {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "action": {
                  "return": "string",
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                }
              }
            ]
          }
        }
      }
    }
  }
}

UserRolesCreateInput: object

roleSlug: String
userIds: ID
accessContextType: AccessContextEnum
accessContextId: ID

Example

{
  "roleSlug": "string",
  "userIds": [
    "string"
  ],
  "accessContextType": "string",
  "accessContextId": "string"
}

UserRolesCreateMutationPayload: object

Autogenerated return type of UserRolesCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
results: object: Contains Array of results of the mutation for participating UserRole resources.
return: MutationResult arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "results": {
    "return": [
      {
        "creationGuard": {
          "return": "string",
          "arguments": {}
        },
        "errors": {
          "return": [
            {
              "message": {
                "return": "string",
                "arguments": {}
              },
              "path": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "success": {
          "return": "boolean",
          "arguments": {}
        },
        "userRole": {
          "return": {
            "accessContext": {
              "arguments": {}
            },
            "accessContextId": {
              "return": "string",
              "arguments": {}
            },
            "accessContextType": {
              "return": "string",
              "arguments": {}
            },
            "applicableAccessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "properties": {
              "return": "object",
              "arguments": {}
            },
            "role": {
              "return": {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "editable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "permissionBased": {
                  "return": "boolean"
                }
              }
            }
          }
        }
      }
    ]
  }
}

UserRolesDeleteByAccessContextInput: object

userId: ID
accessContextType: AccessContextEnum
accessContextId: ID

Example

{
  "userId": "string",
  "accessContextType": "string",
  "accessContextId": "string"
}

UserRolesDeleteByAccessContextMutationPayload: object

Autogenerated return type of UserRolesDeleteByAccessContextMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
results: object: Contains Array of results of the mutation for participating UserRole resources.
return: MutationResult arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "results": {
    "return": [
      {
        "creationGuard": {
          "return": "string",
          "arguments": {}
        },
        "errors": {
          "return": [
            {
              "message": {
                "return": "string",
                "arguments": {}
              },
              "path": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "success": {
          "return": "boolean",
          "arguments": {}
        },
        "userRole": {
          "return": {
            "accessContext": {
              "arguments": {}
            },
            "accessContextId": {
              "return": "string",
              "arguments": {}
            },
            "accessContextType": {
              "return": "string",
              "arguments": {}
            },
            "applicableAccessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "properties": {
              "return": "object",
              "arguments": {}
            },
            "role": {
              "return": {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "editable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "permissionBased": {
                  "return": "boolean"
                }
              }
            }
          }
        }
      }
    ]
  }
}

UserRolesDeleteByIdMutationInput: object

ids: ID

Example

{
  "ids": [
    "string"
  ]
}

UserRolesDeleteByIdMutationPayload: object

Autogenerated return type of UserRolesDeleteByIdMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
results: object: Contains Array of results of the mutation for participating UserRole resources.
return: MutationResult arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "results": {
    "return": [
      {
        "creationGuard": {
          "return": "string",
          "arguments": {}
        },
        "errors": {
          "return": [
            {
              "message": {
                "return": "string",
                "arguments": {}
              },
              "path": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "success": {
          "return": "boolean",
          "arguments": {}
        },
        "userRole": {
          "return": {
            "accessContext": {
              "arguments": {}
            },
            "accessContextId": {
              "return": "string",
              "arguments": {}
            },
            "accessContextType": {
              "return": "string",
              "arguments": {}
            },
            "applicableAccessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "properties": {
              "return": "object",
              "arguments": {}
            },
            "role": {
              "return": {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "editable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "permissionBased": {
                  "return": "boolean"
                }
              }
            }
          }
        }
      }
    ]
  }
}

UserRolesDeleteMutationInput: object

Autogenerated input type of UserRolesDeleteMutation

userIds: ID
roleSlug: String
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "userIds": [
    "string"
  ],
  "roleSlug": "string",
  "clientMutationId": "string"
}

UserRolesDeleteMutationPayload: object

Autogenerated return type of UserRolesDeleteMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
results: object: Contains Array of results of the mutation for participating UserRole resources.
return: MutationResult arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "results": {
    "return": [
      {
        "creationGuard": {
          "return": "string",
          "arguments": {}
        },
        "errors": {
          "return": [
            {
              "message": {
                "return": "string",
                "arguments": {}
              },
              "path": {
                "return": [
                  "string"
                ],
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "success": {
          "return": "boolean",
          "arguments": {}
        },
        "userRole": {
          "return": {
            "accessContext": {
              "arguments": {}
            },
            "accessContextId": {
              "return": "string",
              "arguments": {}
            },
            "accessContextType": {
              "return": "string",
              "arguments": {}
            },
            "applicableAccessContexts": {
              "return": [
                "string"
              ],
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "properties": {
              "return": "object",
              "arguments": {}
            },
            "role": {
              "return": {
                "accessContexts": {
                  "return": [
                    "string"
                  ],
                  "arguments": {}
                },
                "description": {
                  "return": "string",
                  "arguments": {}
                },
                "editable": {
                  "return": "boolean",
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                },
                "name": {
                  "return": "string",
                  "arguments": {}
                },
                "permissionBased": {
                  "return": "boolean"
                }
              }
            }
          }
        }
      }
    ]
  }
}

UserSegment: object

componentTypes: object: A list of unique UserSegmentComponent types.
return: UserSegmentTypeEnum arguments: object
components: object: A paginated list of UserSegmentComponents.
return: UserSegmentComponentAssociationConnection arguments: object after: String Returns the elements in the list that come after the specified cursor. before: String Returns the elements in the list that come before the specified cursor. first: Int Returns the first n elements from the list. last: Int Returns the last n elements from the list.

Example

{
  "componentTypes": {
    "return": [
      "string"
    ],
    "arguments": {}
  },
  "components": {
    "return": {
      "edges": {
        "return": [
          {
            "cursor": {
              "return": "string",
              "arguments": {}
            },
            "node": {
              "return": {
                "accessContext": {
                  "arguments": {}
                },
                "component": {
                  "arguments": {}
                },
                "id": {
                  "return": "string",
                  "arguments": {}
                }
              },
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "nodes": {
        "return": [
          {
            "accessContext": {
              "arguments": {}
            },
            "component": {
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "pageInfo": {
        "return": {
          "endCursor": {
            "return": "string",
            "arguments": {}
          },
          "hasNextPage": {
            "return": "boolean",
            "arguments": {}
          },
          "hasPreviousPage": {
            "return": "boolean",
            "arguments": {}
          },
          "startCursor": {
            "return": "string",
            "arguments": {}
          }
        },
        "arguments": {}
      },
      "totalCount": {
        "return": "number",
        "arguments": {}
      }
    },
    "arguments": {
      "after": "string",
      "before": "string",
      "first": "number",
      "last": "number"
    }
  }
}

UserSegmentComponent: object

accessContext: object: The AccessContext associated with the UserSegmentComponent. This is only valid for Role components.
return: AccessContext arguments: object
component: object: The component that represents a set of segmented users.
return: UserSegmentComponentType arguments: object
id: object: The ID of the UserSegmentComponent
return: ID arguments: object

Example

{
  "accessContext": {
    "arguments": {}
  },
  "component": {
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  }
}

UserSegmentComponentAssociationConnection: object

The connection type for UserSegmentComponent.

edges: object: A list of edges.
return: UserSegmentComponentEdge arguments: object
nodes: object: A list of nodes.
return: UserSegmentComponent arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "accessContext": {
              "arguments": {}
            },
            "component": {
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "accessContext": {
          "arguments": {}
        },
        "component": {
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

UserSegmentComponentCreateInput: object

componentId: ID
componentType: String
accessContextId: ID
accessContextType: AccessContextEnum

Example

{
  "componentId": "string",
  "componentType": "string",
  "accessContextId": "string",
  "accessContextType": "string"
}

UserSegmentComponentEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: UserSegmentComponent arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "accessContext": {
        "arguments": {}
      },
      "component": {
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

UserSegmentComponentType:

Data pertaining to the component that represents a set of segmented Users

Example

UserSegmentCreateInput: object

components: UserSegmentComponentCreateInput

Example

{
  "components": [
    {
      "componentId": "string",
      "componentType": "string",
      "accessContextId": "string",
      "accessContextType": "string"
    }
  ]
}

UserSegmentTypeEnum: string

object User: Segment defined by a User.
object Role: Segment defined by a Role.
object Branch: Segment defined by a Branch.
object ContentPackage: Segment defined by a ContentPackage.
object Group: Segment defined by a Group.
object Tenant: Segment defined by a Tenant.
object RoleAccessContext: Segment defined by a RoleAccessContext.

UserSortAttributes: string

object id: Sort by ID
object sis_id: Sort by SIS ID
object name: Sort by name
object email: Sort by email
object state: Sort by state
object created_at: Sort by time created

UserSortOrderFilter: object

order: SortOrder
by: UserSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

UserUpdateInput: object

id: ID
name: String
email: String
password: String
passwordConfirmation: String
sisId: String
extendedTimeAccommodation: Boolean

Example

{
  "id": "string",
  "name": "string",
  "email": "string",
  "password": "string",
  "passwordConfirmation": "string",
  "sisId": "string",
  "extendedTimeAccommodation": "boolean"
}

UserUpdateMutationPayload: object

Autogenerated return type of UserUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
user: object: User resource participating in the mutation.
return: User arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "user": {
    "return": {
      "authenticationProvider": {
        "return": "string",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              }
            }
          }
        }
      }
    }
  }
}

UsersCreateInput: object

fileName: String
dataFormat: UploadDataFormatEnum
users: UploadUserInput
branchId: ID
groupId: ID
role: UsersCreateRoleInput
branchPlanId: ID

Example

{
  "fileName": "string",
  "dataFormat": "string",
  "users": [
    {
      "name": "string",
      "email": "string",
      "password": "string",
      "sisId": "string"
    }
  ],
  "branchId": "string",
  "groupId": "string",
  "role": {
    "roleSlug": "string",
    "accessContextType": "string",
    "accessContextId": "string"
  },
  "branchPlanId": "string"
}

UsersCreateMutationPayload: object

Autogenerated return type of UsersCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
uploadStatus: object: A message indicating the status of the user upload.
return: String arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "uploadStatus": {
    "return": "string",
    "arguments": {}
  }
}

UsersCreateRoleInput: object

roleSlug: String
accessContextType: AccessContextEnum
accessContextId: ID

Example

{
  "roleSlug": "string",
  "accessContextType": "string",
  "accessContextId": "string"
}

VirtualTraining: object

Represents information about an Virtual Training

createdAt: object: Timestamp when the VirtualTraining was created.
return: ISO8601DateTime arguments: object
hostEmail: object: Email address of the VirtualTraining host.
return: String arguments: object
id: object: Unique identifier ID.
return: ID arguments: object
name: object: Name of the VirtualTraining.
return: String arguments: object
provider: object: Provider of the VirtualTraining.
return: String arguments: object
registrantsCount: object: Number of registrants for the VirtualTraining
return: Int arguments: object
startTime: object: Start date and time of the VirtualTraining.
return: ISO8601DateTime arguments: object
status: object: Status of the VirtualTraining: scheduled, completed, cancelled, recurring.
return: String arguments: object
timeWithTimezone: object: Time with timezone label of the VirtualTraining
return: String arguments: object
trainingType: object: Training type of the VirtualTraining.
return: String arguments: object

Example

{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "hostEmail": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "provider": {
    "return": "string",
    "arguments": {}
  },
  "registrantsCount": {
    "return": "number",
    "arguments": {}
  },
  "startTime": {
    "return": "object",
    "arguments": {}
  },
  "status": {
    "return": "string",
    "arguments": {}
  },
  "timeWithTimezone": {
    "return": "string",
    "arguments": {}
  },
  "trainingType": {
    "return": "string",
    "arguments": {}
  }
}

VirtualTrainingConnection: object

The connection type for VirtualTraining.

edges: object: A list of edges.
return: VirtualTrainingEdge arguments: object
nodes: object: A list of nodes.
return: VirtualTraining arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "hostEmail": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "provider": {
              "return": "string",
              "arguments": {}
            },
            "registrantsCount": {
              "return": "number",
              "arguments": {}
            },
            "startTime": {
              "return": "object",
              "arguments": {}
            },
            "status": {
              "return": "string",
              "arguments": {}
            },
            "timeWithTimezone": {
              "return": "string",
              "arguments": {}
            },
            "trainingType": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "hostEmail": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        },
        "provider": {
          "return": "string",
          "arguments": {}
        },
        "registrantsCount": {
          "return": "number",
          "arguments": {}
        },
        "startTime": {
          "return": "object",
          "arguments": {}
        },
        "status": {
          "return": "string",
          "arguments": {}
        },
        "timeWithTimezone": {
          "return": "string",
          "arguments": {}
        },
        "trainingType": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {}
}

VirtualTrainingEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: VirtualTraining arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "hostEmail": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "provider": {
        "return": "string",
        "arguments": {}
      },
      "registrantsCount": {
        "return": "number",
        "arguments": {}
      },
      "startTime": {
        "return": "object",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "timeWithTimezone": {
        "return": "string",
        "arguments": {}
      },
      "trainingType": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

VirtualTrainingFilter: object

Input fields for virtual training search

ids: ID: Search by IDs
query: String: Smart search across ID and name

Example

{
  "ids": [
    "string"
  ],
  "query": "string"
}

VirtualTrainingSortAttributes: string

object id: Sort by ID
object name: Sort by Name
object start_time: Sort by Start Time

VirtualTrainingSortOrderFilter: object

order: SortOrder
by: VirtualTrainingSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

Voucher: object

Represents information about a plan's vouchers

accessTokenRedemptionsCount: object: Number of times this Voucher has been redeemed.
return: Int arguments: object
branchPlan: object: The BranchPlan (resolver) associated with the Voucher.
return: BranchPlan arguments: object
createdAt: object: Timestamp when the Voucher was created.
return: ISO8601DateTime arguments: object
id: object: ID of the Voucher.
return: ID arguments: object
maxUseCount: object: Maximum number of times a Voucher can be redeemed.
return: Int arguments: object
plan: object: The Plan (resolver) associated with the Voucher.
return: Plan arguments: object
redemptions: object: The AccessTokenRedemptions associated with the Voucher.
return: AccessTokenRedemptionsConnection arguments: object offset: Int The index of the first item in the records to be returned limit: Int 25 The maximum number of records to be returned filters: AccessTokenRedemptionFilter sort: AccessTokenRedemptionSortOrderFilter after: String Returns the elements in the list that come after the specified cursor. before: String Returns the elements in the list that come before the specified cursor. first: Int Returns the first n elements from the list. last: Int Returns the last n elements from the list.
subscriptionsCount: object: Number of current subscriptions using the Voucher.
return: Int arguments: object
token: object: Token created for the Voucher.
return: String arguments: object
usesRemaining: object: Number of redemptions allowed remaining on the Voucher.
return: Int arguments: object

Example

{
  "accessTokenRedemptionsCount": {
    "return": "number",
    "arguments": {}
  },
  "branchPlan": {
    "return": {
      "activatedLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "activeLicenseCount": {
        "return": "number",
        "arguments": {}
      },
      "availableSeatCount": {
        "return": "number",
        "arguments": {}
      },
      "branch": {
        "return": {
          "appliedBranding": {
            "return": {
              "brandableId": {
                "return": "string",
                "arguments": {}
              },
              "brandableType": {
                "return": "string",
                "arguments": {}
              },
              "colorLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "emailLogoUrl": {
                "return": "string",
                "arguments": {}
              },
              "faviconUrl": {
                "return": "string",
                "arguments": {}
              },
              "footer": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "id": {
                "return": "string",
                "arguments": {}
              },
              "marketingPage": {
                "return": {
                  "html": {
                    "return": "string",
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "isDefault": {
                    "return": "boolean",
                    "arguments": {}
                  },
                  "variables": {
                    "return": "object",
                    "arguments": {}
                  }
                },
                "arguments": {}
              },
              "mobileIconUrl": {
                "return": "string",
                "arguments": {}
              },
              "primaryColor": {
                "return": "string",
                "arguments": {}
              },
              "secondaryColor": {}
            }
          }
        }
      }
    }
  }
}

VoucherConnection: object

The connection type for Voucher.

edges: object: A list of edges.
return: VoucherEdge arguments: object
nodes: object: A list of nodes.
return: Voucher arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "accessTokenRedemptionsCount": {
              "return": "number",
              "arguments": {}
            },
            "branchPlan": {
              "return": {
                "activatedLicenseCount": {
                  "return": "number",
                  "arguments": {}
                },
                "activeLicenseCount": {
                  "return": "number",
                  "arguments": {}
                },
                "availableSeatCount": {
                  "return": "number",
                  "arguments": {}
                },
                "branch": {
                  "return": {
                    "appliedBranding": {
                      "return": {
                        "brandableId": {
                          "return": "string",
                          "arguments": {}
                        },
                        "brandableType": {
                          "return": "string",
                          "arguments": {}
                        },
                        "colorLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "emailLogoUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "faviconUrl": {
                          "return": "string",
                          "arguments": {}
                        },
                        "footer": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "isDefault": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "variables": {
                              "return": "object",
                              "arguments": {}
                            }
                          },
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "marketingPage": {
                          "return": {
                            "html": {
                              "return": "string",
                              "arguments": {}
                            },
                            "id": {
                              "return": "string",
                              "arguments": {}
                            },
                            "isDefault": {
                              "return": "boolean",
                              "arguments": {}
                            },
                            "variables": {
                              "return": "object",
                              "arguments": {}
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

VoucherCreateInput: object

planId: ID
branchPlanId: ID
count: Int
maxUseCount: Int
token: String

Example

{
  "planId": "string",
  "branchPlanId": "string",
  "count": "number",
  "maxUseCount": "number",
  "token": "string"
}

VoucherCreateMutationPayload: object

Autogenerated return type of VoucherCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
vouchers: object: Contains Array of Voucher resources participating in the mutation.
return: Voucher arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "vouchers": {
    "return": [
      {
        "accessTokenRedemptionsCount": {
          "return": "number",
          "arguments": {}
        },
        "branchPlan": {
          "return": {
            "activatedLicenseCount": {
              "return": "number",
              "arguments": {}
            },
            "activeLicenseCount": {
              "return": "number",
              "arguments": {}
            },
            "availableSeatCount": {
              "return": "number",
              "arguments": {}
            },
            "branch": {
              "return": {
                "appliedBranding": {
                  "return": {
                    "brandableId": {
                      "return": "string",
                      "arguments": {}
                    },
                    "brandableType": {
                      "return": "string",
                      "arguments": {}
                    },
                    "colorLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "emailLogoUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "faviconUrl": {
                      "return": "string",
                      "arguments": {}
                    },
                    "footer": {
                      "return": {
                        "html": {
                          "return": "string",
                          "arguments": {}
                        },
                        "id": {
                          "return": "string",
                          "arguments": {}
                        },
                        "isDefault": {
                          "return": "boolean",
                          "arguments": {}
                        },
                        "variables": {
                          "return": "object",
                          "arguments": {}
                        }
                      },
                      "arguments": {}
                    },
                    "id": {
                      "return": "string",
                      "arguments": {}
                    },
                    "marketingPage": {
                      "return": {
                        "html": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}

VoucherEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Voucher arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "accessTokenRedemptionsCount": {
        "return": "number",
        "arguments": {}
      },
      "branchPlan": {
        "return": {
          "activatedLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "activeLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "availableSeatCount": {
            "return": "number",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "mobileIconUrl": {
                    "return": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

VoucherFilter: object

Input fields for voucher search

ids: ID: Search by ID
planIds: ID: Search by plan ID
branchPlanIds: ID: Search by branch plan ID
query: String: Smart search by token

Example

{
  "ids": [
    "string"
  ],
  "planIds": [
    "string"
  ],
  "branchPlanIds": [
    "string"
  ],
  "query": "string"
}

VoucherRedemptionInput: object

userId: ID
voucherToken: String

Example

{
  "userId": "string",
  "voucherToken": "string"
}

VoucherRedemptionMutationPayload: object

Autogenerated return type of VoucherRedemptionMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
enrollments: object: Enrollment resources created as a result of redemption.
return: Enrollment arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
license: object: License resource created as a result of redemption.
return: License arguments: object
subscription: object: Subscription resource created as a result of redemption.
return: Subscription arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "enrollments": {
    "return": {
      "additionalResets": {
        "return": "number",
        "arguments": {}
      },
      "baseExamResetLimit": {
        "return": "number",
        "arguments": {}
      },
      "clients": {
        "return": [
          {
            "id": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "contentPackageId": {
        "return": "string",
        "arguments": {}
      },
      "contentPackageTitle": {
        "return": "string",
        "arguments": {}
      },
      "enrolledUntil": {
        "return": "object",
        "arguments": {}
      },
      "examResetsAllowed": {
        "return": "boolean",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "npsRating": {
        "return": "number",
        "arguments": {}
      },
      "status": {
        "return": "string",
        "arguments": {}
      },
      "user": {
        "return": {
          "authenticationProvider": {
            "return": "string",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

VoucherSortAttributes: string

object id: Sort by ID
object token: Sort by Name
object uses_remaining: Sort by Uses Remaining
object subscriptions_count: Sort by Subscription Count
object access_token_redemptions_count: Sort by Redemption Count
object plan_name: Sort by Plan Name

VoucherSortOrderFilter: object

order: SortOrder
by: VoucherSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

VoucherUpdateInput: object

id: ID
maxUseCount: Int

Example

{
  "id": "string",
  "maxUseCount": "number"
}

VoucherUpdateMutationPayload: object

Autogenerated return type of VoucherUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
voucher: object: Voucher resource participating in the mutation.
return: Voucher arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "voucher": {
    "return": {
      "accessTokenRedemptionsCount": {
        "return": "number",
        "arguments": {}
      },
      "branchPlan": {
        "return": {
          "activatedLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "activeLicenseCount": {
            "return": "number",
            "arguments": {}
          },
          "availableSeatCount": {
            "return": "number",
            "arguments": {}
          },
          "branch": {
            "return": {
              "appliedBranding": {
                "return": {
                  "brandableId": {
                    "return": "string",
                    "arguments": {}
                  },
                  "brandableType": {
                    "return": "string",
                    "arguments": {}
                  },
                  "colorLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "emailLogoUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "faviconUrl": {
                    "return": "string",
                    "arguments": {}
                  },
                  "footer": {
                    "return": {
                      "html": {
                        "return": "string",
                        "arguments": {}
                      },
                      "id": {
                        "return": "string",
                        "arguments": {}
                      },
                      "isDefault": {
                        "return": "boolean",
                        "arguments": {}
                      },
                      "variables": {
                        "return": "object",
                        "arguments": {}
                      }
                    },
                    "arguments": {}
                  },
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "marketingPage": {
                    "return": {
                      "html": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Webhook: object

Represents information about a webhook.

contentLocation: object: The content_location that matches (with wildcards) the content_location on the WebhookEvent
return: String arguments: object
contentLocationModels: object: Information about content location models.
return: ContentLocation arguments: object
createdAt: object: Creation timestamp for the Webhook
return: ISO8601DateTime arguments: object
customHeaders: object: Custom headers of the Webhook
return: JSON arguments: object
enabled: object: Indicates whether the Webhook should be handled or ignored
return: Boolean arguments: object
eventType: object: The event_type that matches the event_type on the WebhookEvent
return: String arguments: object
formatter: object: Event Data Formatter for the Webhook.
return: FormatterTypeEnum arguments: object
hmacSecret: object: The secret key used to sign Webhook payloads
return: String arguments: object
id: object: ID of the Webhook
return: ID arguments: object
name: object: The name of the Webhook
return: String arguments: object
url: object: Destination URL for the Webhook
return: String arguments: object

Example

{
  "contentLocation": {
    "return": "string",
    "arguments": {}
  },
  "contentLocationModels": {
    "return": [
      {
        "id": {
          "return": "string",
          "arguments": {}
        },
        "name": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "customHeaders": {
    "return": "object",
    "arguments": {}
  },
  "enabled": {
    "return": "boolean",
    "arguments": {}
  },
  "eventType": {
    "return": "string",
    "arguments": {}
  },
  "formatter": {
    "return": "string",
    "arguments": {}
  },
  "hmacSecret": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "name": {
    "return": "string",
    "arguments": {}
  },
  "url": {
    "return": "string",
    "arguments": {}
  }
}

WebhookConnection: object

The connection type for Webhook.

edges: object: A list of edges.
return: WebhookEdge arguments: object
nodes: object: A list of nodes.
return: Webhook arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "contentLocation": {
              "return": "string",
              "arguments": {}
            },
            "contentLocationModels": {
              "return": [
                {
                  "id": {
                    "return": "string",
                    "arguments": {}
                  },
                  "name": {
                    "return": "string",
                    "arguments": {}
                  }
                }
              ],
              "arguments": {}
            },
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "customHeaders": {
              "return": "object",
              "arguments": {}
            },
            "enabled": {
              "return": "boolean",
              "arguments": {}
            },
            "eventType": {
              "return": "string",
              "arguments": {}
            },
            "formatter": {
              "return": "string",
              "arguments": {}
            },
            "hmacSecret": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            },
            "url": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "contentLocation": {
          "return": "string",
          "arguments": {}
        },
        "contentLocationModels": {
          "return": [
            {
              "id": {
                "return": "string",
                "arguments": {}
              },
              "name": {
                "return": "string",
                "arguments": {}
              }
            }
          ],
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "customHeaders": {
          "return": "object",
          "arguments": {}
        },
        "enabled": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ]
  }
}

WebhookCreateInput: object

name: String
url: String
enabled: Boolean
eventType: String
contentLocation: String
customHeaders: JSON
formatter: FormatterTypeEnum

Example

{
  "name": "string",
  "url": "string",
  "enabled": "boolean",
  "eventType": "string",
  "contentLocation": "string",
  "customHeaders": "object",
  "formatter": "string"
}

WebhookCreateMutationPayload: object

Autogenerated return type of WebhookCreateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
webhook: object: Webhook resource participating in the mutation.
return: Webhook arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "webhook": {
    "return": {
      "contentLocation": {
        "return": "string",
        "arguments": {}
      },
      "contentLocationModels": {
        "return": [
          {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "customHeaders": {
        "return": "object",
        "arguments": {}
      },
      "enabled": {
        "return": "boolean",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "formatter": {
        "return": "string",
        "arguments": {}
      },
      "hmacSecret": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "url": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

WebhookDelivery: object

Represents information about a webhook delivery.

attempt: object: Attempt number of this WebhookDelivery
return: Int arguments: object
createdAt: object: Creation timestamp for the Webhook Delivery
return: ISO8601DateTime arguments: object
id: object: ID of the Webhook Delivery
return: ID arguments: object
responseBody: object: HTTP response body from Webhook destination server
return: String arguments: object
statusCode: object: The HTTP response status code of the Webhook Delivery
return: Int arguments: object
success: object: Boolean value indicating request success or failure
return: Boolean arguments: object
testEvent: object: Boolean value indicating whether the WebhookEvent was real or a test
return: Boolean arguments: object
webhookEventId: object: ID of the asscoated webhook event
return: ID arguments: object
webhookId: object: ID of the associated Webhook
return: ID arguments: object

Example

{
  "attempt": {
    "return": "number",
    "arguments": {}
  },
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "responseBody": {
    "return": "string",
    "arguments": {}
  },
  "statusCode": {
    "return": "number",
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "testEvent": {
    "return": "boolean",
    "arguments": {}
  },
  "webhookEventId": {
    "return": "string",
    "arguments": {}
  },
  "webhookId": {
    "return": "string",
    "arguments": {}
  }
}

WebhookDeliveryConnection: object

The connection type for WebhookDelivery.

edges: object: A list of edges.
return: WebhookDeliveryEdge arguments: object
nodes: object: A list of nodes.
return: WebhookDelivery arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "attempt": {
              "return": "number",
              "arguments": {}
            },
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "responseBody": {
              "return": "string",
              "arguments": {}
            },
            "statusCode": {
              "return": "number",
              "arguments": {}
            },
            "success": {
              "return": "boolean",
              "arguments": {}
            },
            "testEvent": {
              "return": "boolean",
              "arguments": {}
            },
            "webhookEventId": {
              "return": "string",
              "arguments": {}
            },
            "webhookId": {
              "return": "string",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "attempt": {
          "return": "number",
          "arguments": {}
        },
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "responseBody": {
          "return": "string",
          "arguments": {}
        },
        "statusCode": {
          "return": "number",
          "arguments": {}
        },
        "success": {
          "return": "boolean",
          "arguments": {}
        },
        "testEvent": {
          "return": "boolean",
          "arguments": {}
        },
        "webhookEventId": {
          "return": "string",
          "arguments": {}
        },
        "webhookId": {
          "return": "string",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {}
    }
  }
}

WebhookDeliveryEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: WebhookDelivery arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "attempt": {
        "return": "number",
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "responseBody": {
        "return": "string",
        "arguments": {}
      },
      "statusCode": {
        "return": "number",
        "arguments": {}
      },
      "success": {
        "return": "boolean",
        "arguments": {}
      },
      "testEvent": {
        "return": "boolean",
        "arguments": {}
      },
      "webhookEventId": {
        "return": "string",
        "arguments": {}
      },
      "webhookId": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

WebhookDeliveryFilter: object

Input fields for webhook delivery search

ids: ID: Search by IDs
webhookIds: ID: Search by Webhook IDs
webhookEventIds: ID: Search by WebhookEvent IDs

Example

{
  "ids": [
    "string"
  ],
  "webhookIds": [
    "string"
  ],
  "webhookEventIds": [
    "string"
  ]
}

WebhookDeliverySortAttributes: string

object id: Sort by ID
object webhook_id: Sort by Webhook ID
object webhook_event_id: Sort by Webhook Event ID
object attempt: Sort by number of attempts
object test_event: Sort by test_event boolean
object status_code: Sort by HTTP response status code
object created_at: Sort by created_at

WebhookDeliverySortOrderFilter: object

order: SortOrder
by: WebhookDeliverySortAttributes

Example

{
  "order": "string",
  "by": "string"
}

WebhookEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: Webhook arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "contentLocation": {
        "return": "string",
        "arguments": {}
      },
      "contentLocationModels": {
        "return": [
          {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "customHeaders": {
        "return": "object",
        "arguments": {}
      },
      "enabled": {
        "return": "boolean",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "formatter": {
        "return": "string",
        "arguments": {}
      },
      "hmacSecret": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "url": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

WebhookEvent: object

Represents information about a webhook event.

createdAt: object: Creation timestamp for the WebhookEvent
return: ISO8601DateTime arguments: object
data: object: The data of the WebhookEvent
return: JSON arguments: object
deliveriesCount: object: Number of WebhookDelivery records of the WebhokEvent
return: Int arguments: object
eventType: object: The event_type that matches the event_type on the WebhookEvent
return: String arguments: object
id: object: ID of the WebhookEvent
return: ID arguments: object
testEvent: object: Indicates if this event was triggered as a test event
return: Boolean arguments: object

Example

{
  "createdAt": {
    "return": "object",
    "arguments": {}
  },
  "data": {
    "return": "object",
    "arguments": {}
  },
  "deliveriesCount": {
    "return": "number",
    "arguments": {}
  },
  "eventType": {
    "return": "string",
    "arguments": {}
  },
  "id": {
    "return": "string",
    "arguments": {}
  },
  "testEvent": {
    "return": "boolean",
    "arguments": {}
  }
}

WebhookEventConnection: object

The connection type for WebhookEvent.

edges: object: A list of edges.
return: WebhookEventEdge arguments: object
nodes: object: A list of nodes.
return: WebhookEvent arguments: object
pageInfo: object: Information to aid in pagination.
return: PageInfo arguments: object
totalCount: object: Total count of records without pagination.
return: Int arguments: object

Example

{
  "edges": {
    "return": [
      {
        "cursor": {
          "return": "string",
          "arguments": {}
        },
        "node": {
          "return": {
            "createdAt": {
              "return": "object",
              "arguments": {}
            },
            "data": {
              "return": "object",
              "arguments": {}
            },
            "deliveriesCount": {
              "return": "number",
              "arguments": {}
            },
            "eventType": {
              "return": "string",
              "arguments": {}
            },
            "id": {
              "return": "string",
              "arguments": {}
            },
            "testEvent": {
              "return": "boolean",
              "arguments": {}
            }
          },
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "nodes": {
    "return": [
      {
        "createdAt": {
          "return": "object",
          "arguments": {}
        },
        "data": {
          "return": "object",
          "arguments": {}
        },
        "deliveriesCount": {
          "return": "number",
          "arguments": {}
        },
        "eventType": {
          "return": "string",
          "arguments": {}
        },
        "id": {
          "return": "string",
          "arguments": {}
        },
        "testEvent": {
          "return": "boolean",
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "pageInfo": {
    "return": {
      "endCursor": {
        "return": "string",
        "arguments": {}
      },
      "hasNextPage": {
        "return": "boolean",
        "arguments": {}
      },
      "hasPreviousPage": {
        "return": "boolean",
        "arguments": {}
      },
      "startCursor": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  },
  "totalCount": {
    "return": "number",
    "arguments": {}
  }
}

WebhookEventEdge: object

An edge in a connection.

cursor: object: A cursor for use in pagination.
return: String arguments: object
node: object: The item at the end of the edge.
return: WebhookEvent arguments: object

Example

{
  "cursor": {
    "return": "string",
    "arguments": {}
  },
  "node": {
    "return": {
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "data": {
        "return": "object",
        "arguments": {}
      },
      "deliveriesCount": {
        "return": "number",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "testEvent": {
        "return": "boolean",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

WebhookEventFilter: object

Input fields for webhook event search

ids: ID: Search by IDs
eventType: String: Filter by trigger event type
startDate: ISO8601DateTime: Filter to WebhookEvents created after the given timestamp (inclusively)
endDate: ISO8601DateTime: Filter to WebhookEvents created before the given timestamp (inclusively)

Example

{
  "ids": [
    "string"
  ],
  "eventType": "string",
  "startDate": "object",
  "endDate": "object"
}

WebhookEventSortAttributes: string

object id: Sort by ID
object event_type: Sort by trigger event_type
object test_event: Sort by test_event
object created_at: Sort by created_at

WebhookEventSortOrderFilter: object

order: SortOrder
by: WebhookEventSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

WebhookFilter: object

Input fields for webhook search

ids: ID: Search by IDs
query: String: Smart search across ID and name
enabled: Boolean: Return webhook status
eventType: String: Filter by trigger event type

Example

{
  "ids": [
    "string"
  ],
  "query": "string",
  "enabled": "boolean",
  "eventType": "string"
}

WebhookResendDeliveryMutationInput: object

Autogenerated input type of WebhookResendDeliveryMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

WebhookResendDeliveryMutationPayload: object

Autogenerated return type of WebhookResendDeliveryMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
deliveryJobInProgress: object: Boolean value indicating whether the delivery job is queued or in progress
return: Boolean arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "deliveryJobInProgress": {
    "return": "boolean",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  }
}

WebhookSortAttributes: string

object id: Sort by ID
object name: Sort by name
object event_type: Sort by trigger event_type
object enabled: Sort by enabled

WebhookSortOrderFilter: object

order: SortOrder
by: WebhookSortAttributes

Example

{
  "order": "string",
  "by": "string"
}

WebhookTestMutationInput: object

Autogenerated input type of WebhookTestMutation

id: ID
clientMutationId: String: A unique identifier for the client performing the mutation.

Example

{
  "id": "string",
  "clientMutationId": "string"
}

WebhookTestMutationPayload: object

Autogenerated return type of WebhookTestMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
webhook: object: Webhook resource being tested.
return: Webhook arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "webhook": {
    "return": {
      "contentLocation": {
        "return": "string",
        "arguments": {}
      },
      "contentLocationModels": {
        "return": [
          {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "customHeaders": {
        "return": "object",
        "arguments": {}
      },
      "enabled": {
        "return": "boolean",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "formatter": {
        "return": "string",
        "arguments": {}
      },
      "hmacSecret": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "url": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

WebhookUpdateInput: object

id: ID
name: String
url: String
enabled: Boolean
eventType: String
contentLocation: String
customHeaders: JSON

Example

{
  "id": "string",
  "name": "string",
  "url": "string",
  "enabled": "boolean",
  "eventType": "string",
  "contentLocation": "string",
  "customHeaders": "object"
}

WebhookUpdateMutationPayload: object

Autogenerated return type of WebhookUpdateMutation

clientMutationId: object: A unique identifier for the client performing the mutation.
return: String arguments: object
errors: object: Errors encountered during Mutation execution
return: RecordError arguments: object
success: object: Indicates the status of the Mutation
return: Boolean arguments: object
webhook: object: Webhook resource participating in the mutation.
return: Webhook arguments: object

Example

{
  "clientMutationId": {
    "return": "string",
    "arguments": {}
  },
  "errors": {
    "return": [
      {
        "message": {
          "return": "string",
          "arguments": {}
        },
        "path": {
          "return": [
            "string"
          ],
          "arguments": {}
        }
      }
    ],
    "arguments": {}
  },
  "success": {
    "return": "boolean",
    "arguments": {}
  },
  "webhook": {
    "return": {
      "contentLocation": {
        "return": "string",
        "arguments": {}
      },
      "contentLocationModels": {
        "return": [
          {
            "id": {
              "return": "string",
              "arguments": {}
            },
            "name": {
              "return": "string",
              "arguments": {}
            }
          }
        ],
        "arguments": {}
      },
      "createdAt": {
        "return": "object",
        "arguments": {}
      },
      "customHeaders": {
        "return": "object",
        "arguments": {}
      },
      "enabled": {
        "return": "boolean",
        "arguments": {}
      },
      "eventType": {
        "return": "string",
        "arguments": {}
      },
      "formatter": {
        "return": "string",
        "arguments": {}
      },
      "hmacSecret": {
        "return": "string",
        "arguments": {}
      },
      "id": {
        "return": "string",
        "arguments": {}
      },
      "name": {
        "return": "string",
        "arguments": {}
      },
      "url": {
        "return": "string",
        "arguments": {}
      }
    },
    "arguments": {}
  }
}

BenchPrep