Input types are very similar to Types. However these are used to define what fields you can provide to the service when providing data.

Here String! denotes that the field is required.

Admin User

This is used when creating an MSP or tenant account so we can email them an invite to sign into the platform.

input AdminUser {
  email: String!
  firstName: String!
	lastName: String!
}

Tenant Settings

enum BlockedFreeEmailType {
  all
  learner
	user
  none
}

input DefaultPolicySignatureSettingsInput {
  type: PolicySignatureType!
  startDate: Date
  intervalLength: Int
  intervalUnit: PolicySignatureSettingsIntervalUnit
}

input TenantSettings {
  freeTrial: Boolean!

	# Lock learners/users to the domain they signed up with
  domainLock: Boolean!

	# Lock the account to set amount of seats
  **learnerLimit: Int
	
	# Ability to toggle parts of the app off/on
  uBreachEnabled: Boolean
  uLearn: Boolean
  uPhish: Boolean
  uPolicy: Boolean
	enableRiskScore: Boolean
	allowBlockedFreeEmails: BlockedFreeEmailType
  allowBlockedFreeEmailsLearner: Boolean
  allowBlockedFreeEmailsUser: Boolean
	policySignatureSettings: DefaultPolicySignatureSettingsInput

	# Enable/disable uBreach Pro
	uBreachProEnabled: Boolean
	# Add monitored domains to the uBreach Pro settings on the tenant
	uBreachProDomains: [String]

	# Theme Settings
	appThemeLogo: String # URL of hosted logo image
  appThemeNavColor: String
  appThemePrimaryColor: String
  appThemeSecondaryColor: String
}

MSP Settings

Please that only distributor partners can create or modify MSP accounts using this API.

# Platform settings for MSP
input PartnerSettings {
		# Gives the MSP account access all system features.
		# They will only have access to uService if this option is disabled.
    platformAccess: Boolean

		# Lock learners/users to the domain they signed up with
    domainLock: Boolean

		# Enable/disable uBreach Pro
    uBreachProEnabled: Boolean

		# Theme Settings
    appThemeLogo: String # URL of hosted logo image
    appThemeNavColor: String
    appThemePrimaryColor: String
    appThemeSecondaryColor: String
}

Policy Signature Settings

enum PolicyDocumentType {
    editor
    pdf
}

enum PolicySignatureSettingsIntervalUnit {
    months
    years
}

input PolicySignatureSettingsInput {
    type: PolicySignatureType
    startDate: Date
    intervalLength: Int
    intervalUnit: PolicySignatureSettingsIntervalUnit
    useDefault: Boolean
    setDefault: Boolean
}

uBreach - breached services and breached users

input BreachedUserFilterInput {
  activeLearners: Boolean
  inactiveLearners: Boolean
  nonLearners: Boolean
}

As part of both the breachedUsers and breachedServices query, the BreachedUserFilterInput can be used to filter users that will be returned in each query.

Each property can be set to true or false to affect the users returned, for example an input of:

{
  activeLearners: true
  inactiveLearners: false
  nonLearners: false
}

Will only include users that have an account set up on Usecure and the account is still active