openapi: "3.0.3" info: version: 1.55.1 title: FusionAuth API description: "This is a FusionAuth server. Find out more at [https://fusionauth.io](https://fusionauth.io). You need to [set up an API key](https://fusionauth.io/docs/v1/tech/apis/authentication#managing-api-keys) in the FusionAuth instance you are using to test out the API calls." license: name: Apache2 servers: - url: http://localhost:9011 - url: https://sandbox.fusionauth.io security: - ApiKeyAuth: [] components: schemas: APIKey: description: domain POJO to represent AuthenticationKey type: object properties: expirationInstant: "$ref": "#/components/schemas/ZonedDateTime" id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" ipAccessControlListId: type: string format: uuid key: type: string keyManager: type: boolean lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" metaData: "$ref": "#/components/schemas/APIKeyMetaData" permissions: "$ref": "#/components/schemas/APIKeyPermissions" tenantId: type: string format: uuid APIKeyMetaData: type: object properties: attributes: type: object additionalProperties: type: string APIKeyPermissions: type: object properties: endpoints: type: object additionalProperties: type: array uniqueItems: true items: {} APIKeyRequest: description: Authentication key request object. type: object properties: apiKey: "$ref": "#/components/schemas/APIKey" sourceKeyId: type: string format: uuid APIKeyResponse: description: Authentication key response object. type: object properties: apiKey: "$ref": "#/components/schemas/APIKey" AccessToken: description: '' type: object properties: expires_in: type: integer id_token: type: string refresh_token: type: string refresh_token_id: type: string format: uuid scope: type: string access_token: type: string token_type: "$ref": "#/components/schemas/TokenType" userId: type: string format: uuid ActionData: type: object properties: actioneeUserId: type: string format: uuid actionerUserId: type: string format: uuid applicationIds: type: array items: type: string format: uuid comment: type: string emailUser: type: boolean expiry: "$ref": "#/components/schemas/ZonedDateTime" notifyUser: type: boolean option: type: string reasonId: type: string format: uuid userActionId: type: string format: uuid ActionRequest: description: The user action request object. type: object properties: action: "$ref": "#/components/schemas/ActionData" broadcast: type: boolean eventInfo: "$ref": "#/components/schemas/EventInfo" ActionResponse: description: The user action response object. type: object properties: action: "$ref": "#/components/schemas/UserActionLog" actions: type: array items: "$ref": "#/components/schemas/UserActionLog" Algorithm: description: Available JSON Web Algorithms (JWA) as described in RFC 7518 available for this JWT implementation. type: string enum: - ES256 - ES384 - ES512 - HS256 - HS384 - HS512 - PS256 - PS384 - PS512 - RS256 - RS384 - RS512 - none AppleApplicationConfiguration: description: '' type: object properties: bundleId: type: string buttonText: type: string keyId: type: string format: uuid scope: type: string servicesId: type: string teamId: type: string data: type: object additionalProperties: type: object createRegistration: type: boolean AppleIdentityProvider: description: '' type: object properties: bundleId: type: string buttonText: type: string keyId: type: string format: uuid scope: type: string servicesId: type: string teamId: type: string data: type: object additionalProperties: type: object applicationConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/AppleApplicationConfiguration" debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lambdaConfiguration: "$ref": "#/components/schemas/ProviderLambdaConfiguration" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" linkingStrategy: "$ref": "#/components/schemas/IdentityProviderLinkingStrategy" name: type: string tenantConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/IdentityProviderTenantConfiguration" type: "$ref": "#/components/schemas/IdentityProviderType" Application: description: '' type: object properties: accessControlConfiguration: "$ref": "#/components/schemas/ApplicationAccessControlConfiguration" active: type: boolean authenticationTokenConfiguration: "$ref": "#/components/schemas/AuthenticationTokenConfiguration" cleanSpeakConfiguration: "$ref": "#/components/schemas/CleanSpeakConfiguration" data: type: object additionalProperties: type: object emailConfiguration: "$ref": "#/components/schemas/ApplicationEmailConfiguration" externalIdentifierConfiguration: "$ref": "#/components/schemas/ApplicationExternalIdentifierConfiguration" formConfiguration: "$ref": "#/components/schemas/ApplicationFormConfiguration" id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" jwtConfiguration: "$ref": "#/components/schemas/JWTConfiguration" lambdaConfiguration: "$ref": "#/components/schemas/LambdaConfiguration" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" loginConfiguration: "$ref": "#/components/schemas/LoginConfiguration" multiFactorConfiguration: "$ref": "#/components/schemas/ApplicationMultiFactorConfiguration" name: type: string oauthConfiguration: "$ref": "#/components/schemas/OAuth2Configuration" passwordlessConfiguration: "$ref": "#/components/schemas/PasswordlessConfiguration" registrationConfiguration: "$ref": "#/components/schemas/RegistrationConfiguration" registrationDeletePolicy: "$ref": "#/components/schemas/ApplicationRegistrationDeletePolicy" roles: type: array items: "$ref": "#/components/schemas/ApplicationRole" samlv2Configuration: "$ref": "#/components/schemas/SAMLv2Configuration" scopes: type: array items: "$ref": "#/components/schemas/ApplicationOAuthScope" state: "$ref": "#/components/schemas/ObjectState" tenantId: type: string format: uuid themeId: type: string format: uuid unverified: "$ref": "#/components/schemas/RegistrationUnverifiedOptions" verificationEmailTemplateId: type: string format: uuid verificationStrategy: "$ref": "#/components/schemas/VerificationStrategy" verifyRegistration: type: boolean webAuthnConfiguration: "$ref": "#/components/schemas/ApplicationWebAuthnConfiguration" ApplicationAccessControlConfiguration: description: '' type: object properties: uiIPAccessControlListId: type: string format: uuid ApplicationEmailConfiguration: type: object properties: emailUpdateEmailTemplateId: type: string format: uuid emailVerificationEmailTemplateId: type: string format: uuid emailVerifiedEmailTemplateId: type: string format: uuid forgotPasswordEmailTemplateId: type: string format: uuid loginIdInUseOnCreateEmailTemplateId: type: string format: uuid loginIdInUseOnUpdateEmailTemplateId: type: string format: uuid loginNewDeviceEmailTemplateId: type: string format: uuid loginSuspiciousEmailTemplateId: type: string format: uuid passwordResetSuccessEmailTemplateId: type: string format: uuid passwordUpdateEmailTemplateId: type: string format: uuid passwordlessEmailTemplateId: type: string format: uuid setPasswordEmailTemplateId: type: string format: uuid twoFactorMethodAddEmailTemplateId: type: string format: uuid twoFactorMethodRemoveEmailTemplateId: type: string format: uuid ApplicationEvent: description: Events that are bound to applications. type: object properties: {} ApplicationExternalIdentifierConfiguration: description: '' type: object properties: twoFactorTrustIdTimeToLiveInSeconds: type: integer ApplicationFormConfiguration: description: '' type: object properties: adminRegistrationFormId: type: string format: uuid selfServiceFormConfiguration: "$ref": "#/components/schemas/SelfServiceFormConfiguration" selfServiceFormId: type: string format: uuid ApplicationMultiFactorConfiguration: description: '' type: object properties: email: "$ref": "#/components/schemas/MultiFactorEmailTemplate" loginPolicy: "$ref": "#/components/schemas/MultiFactorLoginPolicy" sms: "$ref": "#/components/schemas/MultiFactorSMSTemplate" trustPolicy: "$ref": "#/components/schemas/ApplicationMultiFactorTrustPolicy" ApplicationMultiFactorTrustPolicy: description: '' type: string enum: - Any - This - None ApplicationOAuthScope: description: A custom OAuth scope for a specific application. type: object properties: applicationId: type: string format: uuid data: type: object additionalProperties: type: object defaultConsentDetail: type: string defaultConsentMessage: type: string description: type: string id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string required: type: boolean ApplicationOAuthScopeRequest: description: The Application Scope API request object. type: object properties: scope: "$ref": "#/components/schemas/ApplicationOAuthScope" ApplicationOAuthScopeResponse: description: The Application Scope API response. type: object properties: scope: "$ref": "#/components/schemas/ApplicationOAuthScope" ApplicationRegistrationDeletePolicy: description: A Application-level policy for deleting Users. type: object properties: unverified: "$ref": "#/components/schemas/TimeBasedDeletePolicy" ApplicationRequest: description: The Application API request object. type: object properties: application: "$ref": "#/components/schemas/Application" role: "$ref": "#/components/schemas/ApplicationRole" sourceApplicationId: type: string format: uuid eventInfo: "$ref": "#/components/schemas/EventInfo" ApplicationResponse: description: The Application API response. type: object properties: application: "$ref": "#/components/schemas/Application" applications: type: array items: "$ref": "#/components/schemas/Application" role: "$ref": "#/components/schemas/ApplicationRole" ApplicationRole: description: A role given to a user for a specific application. type: object properties: description: type: string id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" isDefault: type: boolean isSuperRole: type: boolean lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string ApplicationSearchCriteria: description: Search criteria for Applications type: object properties: name: type: string state: "$ref": "#/components/schemas/ObjectState" tenantId: type: string format: uuid numberOfResults: type: integer orderBy: type: string startRow: type: integer ApplicationSearchRequest: description: Search request for Applications type: object properties: search: "$ref": "#/components/schemas/ApplicationSearchCriteria" expand: type: array items: type: string ApplicationSearchResponse: description: Application search response type: object properties: applications: type: array items: "$ref": "#/components/schemas/Application" total: type: integer format: int64 expandable: type: array items: type: string ApplicationWebAuthnConfiguration: description: Application-level configuration for WebAuthn type: object properties: bootstrapWorkflow: "$ref": "#/components/schemas/ApplicationWebAuthnWorkflowConfiguration" reauthenticationWorkflow: "$ref": "#/components/schemas/ApplicationWebAuthnWorkflowConfiguration" enabled: type: boolean ApplicationWebAuthnWorkflowConfiguration: description: '' type: object properties: enabled: type: boolean Attachment: description: This class is a simple attachment with a byte array, name and MIME type. type: object properties: attachment: type: string format: binary mime: type: string name: type: string AttestationConveyancePreference: description: Used to communicate whether and how authenticator attestation should be delivered to the Relying Party type: string enum: - none - indirect - direct - enterprise AttestationType: description: Used to indicate what type of attestation was included in the authenticator response for a given WebAuthn credential at the time it was created type: string enum: - basic - self - attestationCa - anonymizationCa - none AuditLog: description: An audit log. type: object properties: data: type: object additionalProperties: type: object id: type: integer format: int64 insertInstant: "$ref": "#/components/schemas/ZonedDateTime" insertUser: type: string message: type: string newValue: type: object oldValue: type: object reason: type: string AuditLogConfiguration: type: object properties: delete: "$ref": "#/components/schemas/DeleteConfiguration" AuditLogCreateEvent: description: Event to indicate an audit log was created. type: object properties: auditLog: "$ref": "#/components/schemas/AuditLog" createInstant: "$ref": "#/components/schemas/ZonedDateTime" id: type: string format: uuid info: "$ref": "#/components/schemas/EventInfo" tenantId: type: string format: uuid type: "$ref": "#/components/schemas/EventType" AuditLogExportRequest: description: '' type: object properties: criteria: "$ref": "#/components/schemas/AuditLogSearchCriteria" dateTimeSecondsFormat: type: string zoneId: "$ref": "#/components/schemas/ZoneId" AuditLogRequest: description: '' type: object properties: auditLog: "$ref": "#/components/schemas/AuditLog" eventInfo: "$ref": "#/components/schemas/EventInfo" AuditLogResponse: description: Audit log response. type: object properties: auditLog: "$ref": "#/components/schemas/AuditLog" AuditLogSearchCriteria: description: '' type: object properties: end: "$ref": "#/components/schemas/ZonedDateTime" message: type: string newValue: type: string oldValue: type: string reason: type: string start: "$ref": "#/components/schemas/ZonedDateTime" user: type: string numberOfResults: type: integer orderBy: type: string startRow: type: integer AuditLogSearchRequest: description: '' type: object properties: search: "$ref": "#/components/schemas/AuditLogSearchCriteria" AuditLogSearchResponse: description: Audit log response. type: object properties: auditLogs: type: array items: "$ref": "#/components/schemas/AuditLog" total: type: integer format: int64 AuthenticationThreats: description: '' type: string enum: - ImpossibleTravel AuthenticationTokenConfiguration: type: object properties: enabled: type: boolean AuthenticatorAttachment: description: Describes the authenticator attachment modality. type: string enum: - platform - crossPlatform AuthenticatorAttachmentPreference: description: Describes the authenticator attachment modality preference for a WebAuthn workflow. See {@link AuthenticatorAttachment} type: string enum: - any - platform - crossPlatform AuthenticatorConfiguration: description: '' type: object properties: algorithm: "$ref": "#/components/schemas/TOTPAlgorithm" codeLength: type: integer timeStep: type: integer AuthenticatorSelectionCriteria: description: Used by the Relying Party to specify their requirements for authenticator attributes. Fields use the deprecated "resident key" terminology to refer to client-side discoverable credentials to maintain backwards compatibility with WebAuthn Level 1. type: object properties: authenticatorAttachment: "$ref": "#/components/schemas/AuthenticatorAttachment" requireResidentKey: type: boolean residentKey: "$ref": "#/components/schemas/ResidentKeyRequirement" userVerification: "$ref": "#/components/schemas/UserVerificationRequirement" BaseConnectorConfiguration: description: Do not require a setter for 'type', it is defined by the concrete class and is not mutable type: object properties: data: type: object additionalProperties: type: object debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string type: "$ref": "#/components/schemas/ConnectorType" BaseElasticSearchCriteria: description: '' type: object properties: accurateTotal: type: boolean ids: type: array items: type: string format: uuid nextResults: type: string query: type: string queryString: type: string sortFields: type: array items: "$ref": "#/components/schemas/SortField" numberOfResults: type: integer orderBy: type: string startRow: type: integer BaseEvent: description: Base class for all FusionAuth events. type: object properties: createInstant: "$ref": "#/components/schemas/ZonedDateTime" id: type: string format: uuid info: "$ref": "#/components/schemas/EventInfo" tenantId: type: string format: uuid type: "$ref": "#/components/schemas/EventType" BaseEventRequest: description: Base class for requests that can contain event information. This event information is used when sending Webhooks or emails during the transaction. The caller is responsible for ensuring that the event information is correct. type: object properties: eventInfo: "$ref": "#/components/schemas/EventInfo" BaseExportRequest: description: '' type: object properties: dateTimeSecondsFormat: type: string zoneId: "$ref": "#/components/schemas/ZoneId" BaseGroupEvent: description: Base class for all {@link Group} and {@link GroupMember} events. type: object properties: group: "$ref": "#/components/schemas/Group" createInstant: "$ref": "#/components/schemas/ZonedDateTime" id: type: string format: uuid info: "$ref": "#/components/schemas/EventInfo" tenantId: type: string format: uuid type: "$ref": "#/components/schemas/EventType" BaseIdentityProviderApplicationConfiguration: description: '' type: object properties: data: type: object additionalProperties: type: object createRegistration: type: boolean enabled: type: boolean BaseLoginRequest: description: '' type: object properties: applicationId: type: string format: uuid ipAddress: type: string metaData: "$ref": "#/components/schemas/MetaData" newDevice: type: boolean noJWT: type: boolean eventInfo: "$ref": "#/components/schemas/EventInfo" BaseMessengerConfiguration: description: Do not require a setter for 'type', it is defined by the concrete class and is not mutable type: object properties: data: type: object additionalProperties: type: object debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string transport: type: string type: "$ref": "#/components/schemas/MessengerType" BaseSearchCriteria: description: '' type: object properties: numberOfResults: type: integer orderBy: type: string startRow: type: integer BaseUserEvent: description: Base class for all {@link User}-related events. type: object properties: user: "$ref": "#/components/schemas/User" createInstant: "$ref": "#/components/schemas/ZonedDateTime" id: type: string format: uuid info: "$ref": "#/components/schemas/EventInfo" tenantId: type: string format: uuid type: "$ref": "#/components/schemas/EventType" BreachAction: type: string enum: - 'Off' - RecordOnly - NotifyUser - RequireChange BreachMatchMode: type: string enum: - Low - Medium - High BreachedPasswordStatus: description: '' type: string enum: - None - ExactMatch - SubAddressMatch - PasswordOnly - CommonPassword BreachedPasswordTenantMetric: description: '' type: object properties: actionRequired: type: integer matchedCommonPasswordCount: type: integer matchedExactCount: type: integer matchedPasswordCount: type: integer matchedSubAddressCount: type: integer passwordsCheckedCount: type: integer CORSConfiguration: description: '' type: object properties: allowCredentials: type: boolean allowedHeaders: type: array items: type: string allowedMethods: type: array items: "$ref": "#/components/schemas/HTTPMethod" allowedOrigins: type: array items: type: string format: URI debug: type: boolean exposedHeaders: type: array items: type: string preflightMaxAgeInSeconds: type: integer enabled: type: boolean CanonicalizationMethod: description: XML canonicalization method enumeration. This is used for the IdP and SP side of FusionAuth SAML. type: string enum: - exclusive - exclusive_with_comments - inclusive - inclusive_with_comments CaptchaMethod: description: '' type: string enum: - GoogleRecaptchaV2 - GoogleRecaptchaV3 - HCaptcha - HCaptchaEnterprise CertificateInformation: type: object properties: issuer: type: string md5Fingerprint: type: string serialNumber: type: string sha1Fingerprint: type: string sha1Thumbprint: type: string sha256Fingerprint: type: string sha256Thumbprint: type: string subject: type: string validFrom: "$ref": "#/components/schemas/ZonedDateTime" validTo: "$ref": "#/components/schemas/ZonedDateTime" ChangePasswordReason: description: '' type: string enum: - Administrative - Breached - Expired - Validation ChangePasswordRequest: description: Change password request object. type: object properties: applicationId: type: string format: uuid changePasswordId: type: string currentPassword: type: string loginId: type: string password: type: string refreshToken: type: string trustChallenge: type: string trustToken: type: string eventInfo: "$ref": "#/components/schemas/EventInfo" ChangePasswordResponse: description: Change password response object. type: object properties: oneTimePassword: type: string state: type: object additionalProperties: type: object CleanSpeakConfiguration: description: CleanSpeak configuration at the system and application level. type: object properties: apiKey: type: string applicationIds: type: array items: type: string format: uuid url: type: string format: URI usernameModeration: "$ref": "#/components/schemas/UsernameModeration" enabled: type: boolean ClientAuthenticationMethod: type: string enum: - none - client_secret_basic - client_secret_post ClientAuthenticationPolicy: description: '' type: string enum: - Required - NotRequired - NotRequiredWhenUsingPKCE ConnectorLambdaConfiguration: type: object properties: reconcileId: type: string format: uuid ConnectorPolicy: description: '' type: object properties: connectorId: type: string format: uuid data: type: object additionalProperties: type: object domains: type: array uniqueItems: true items: {} migrate: type: boolean ConnectorRequest: description: '' type: object properties: connector: "$ref": "#/components/schemas/BaseConnectorConfiguration" ConnectorResponse: description: '' type: object properties: connector: "$ref": "#/components/schemas/BaseConnectorConfiguration" connectors: type: array items: "$ref": "#/components/schemas/BaseConnectorConfiguration" ConnectorType: description: The types of connectors. This enum is stored as an ordinal on the identities table, order must be maintained. type: string enum: - FusionAuth - Generic - LDAP Consent: description: Models a consent. type: object properties: data: type: object additionalProperties: type: object consentEmailTemplateId: type: string format: uuid countryMinimumAgeForSelfConsent: "$ref": "#/components/schemas/LocalizedIntegers" defaultMinimumAgeForSelfConsent: type: integer emailPlus: "$ref": "#/components/schemas/EmailPlus" id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" multipleValuesAllowed: type: boolean name: type: string values: type: array items: type: string ConsentRequest: description: API request for User consent types. type: object properties: consent: "$ref": "#/components/schemas/Consent" ConsentResponse: description: API response for consent. type: object properties: consent: "$ref": "#/components/schemas/Consent" consents: type: array items: "$ref": "#/components/schemas/Consent" ConsentSearchCriteria: description: Search criteria for Consents type: object properties: name: type: string numberOfResults: type: integer orderBy: type: string startRow: type: integer ConsentSearchRequest: description: Search request for Consents type: object properties: search: "$ref": "#/components/schemas/ConsentSearchCriteria" ConsentSearchResponse: description: Consent search response type: object properties: consents: type: array items: "$ref": "#/components/schemas/Consent" total: type: integer format: int64 ConsentStatus: description: Models a consent. type: string enum: - Active - Revoked ContentStatus: description: Status for content like usernames, profile attributes, etc. type: string enum: - ACTIVE - PENDING - REJECTED CoseAlgorithmIdentifier: description: A number identifying a cryptographic algorithm. Values should be registered with the IANA COSE Algorithms registry type: string enum: - ES256 - ES384 - ES512 - RS256 - RS384 - RS512 - PS256 - PS384 - PS512 CoseEllipticCurve: description: COSE Elliptic Curve identifier to determine which elliptic curve to use with a given key type: string enum: - Reserved - P256 - P384 - P521 - X25519 - X448 - Ed25519 - Ed448 - Secp256k1 CoseKeyType: description: COSE key type type: string enum: - Reserved - OKP - EC2 - RSA - Symmetric Count: description: '' type: object properties: count: type: integer interval: type: integer CredentialPropertiesOutput: description: Contains the output for the {@code credProps} extension type: object properties: rk: type: boolean DailyActiveUserReportResponse: description: Response for the daily active user report. type: object properties: dailyActiveUsers: type: array items: "$ref": "#/components/schemas/Count" total: type: integer format: int64 DeleteConfiguration: type: object properties: numberOfDaysToRetain: type: integer enabled: type: boolean DeviceApprovalResponse: description: '' type: object properties: deviceGrantStatus: type: string deviceInfo: "$ref": "#/components/schemas/DeviceInfo" identityProviderLink: "$ref": "#/components/schemas/IdentityProviderLink" tenantId: type: string format: uuid userId: type: string format: uuid DeviceInfo: description: '' type: object properties: description: type: string lastAccessedAddress: type: string lastAccessedInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string type: type: string DeviceResponse: description: '' type: object properties: device_code: type: string expires_in: type: integer interval: type: integer user_code: type: string verification_uri: type: string format: URI verification_uri_complete: type: string format: URI DeviceType: type: string enum: - BROWSER - DESKTOP - LAPTOP - MOBILE - OTHER - SERVER - TABLET - TV - UNKNOWN DeviceUserCodeResponse: description: '' type: object properties: client_id: type: string deviceInfo: "$ref": "#/components/schemas/DeviceInfo" expires_in: type: integer pendingIdPLink: "$ref": "#/components/schemas/PendingIdPLink" scope: type: string tenantId: type: string format: uuid user_code: type: string DisplayableRawLogin: description: A displayable raw login that includes application name and user loginId. type: object properties: applicationName: type: string location: "$ref": "#/components/schemas/Location" loginId: type: string applicationId: type: string format: uuid instant: "$ref": "#/components/schemas/ZonedDateTime" ipAddress: type: string userId: type: string format: uuid DomainBasedIdentityProvider: description: Interface for all identity providers that can be domain based. type: object properties: {} Email: description: This class is an abstraction of a simple email message. type: object properties: attachments: type: array items: "$ref": "#/components/schemas/Attachment" bcc: type: array items: "$ref": "#/components/schemas/EmailAddress" cc: type: array items: "$ref": "#/components/schemas/EmailAddress" from: "$ref": "#/components/schemas/EmailAddress" html: type: string replyTo: "$ref": "#/components/schemas/EmailAddress" subject: type: string text: type: string to: type: array items: "$ref": "#/components/schemas/EmailAddress" EmailAddress: description: An email address. type: object properties: address: type: string display: type: string EmailConfiguration: description: '' type: object properties: additionalHeaders: type: array items: "$ref": "#/components/schemas/EmailHeader" debug: type: boolean defaultFromEmail: type: string defaultFromName: type: string emailUpdateEmailTemplateId: type: string format: uuid emailVerifiedEmailTemplateId: type: string format: uuid forgotPasswordEmailTemplateId: type: string format: uuid host: type: string implicitEmailVerificationAllowed: type: boolean loginIdInUseOnCreateEmailTemplateId: type: string format: uuid loginIdInUseOnUpdateEmailTemplateId: type: string format: uuid loginNewDeviceEmailTemplateId: type: string format: uuid loginSuspiciousEmailTemplateId: type: string format: uuid password: type: string passwordResetSuccessEmailTemplateId: type: string format: uuid passwordUpdateEmailTemplateId: type: string format: uuid passwordlessEmailTemplateId: type: string format: uuid port: type: integer properties: type: string security: "$ref": "#/components/schemas/EmailSecurityType" setPasswordEmailTemplateId: type: string format: uuid twoFactorMethodAddEmailTemplateId: type: string format: uuid twoFactorMethodRemoveEmailTemplateId: type: string format: uuid unverified: "$ref": "#/components/schemas/EmailUnverifiedOptions" username: type: string verificationEmailTemplateId: type: string format: uuid verificationStrategy: "$ref": "#/components/schemas/VerificationStrategy" verifyEmail: type: boolean verifyEmailWhenChanged: type: boolean EmailHeader: description: '' type: object properties: name: type: string value: type: string EmailPlus: type: object properties: emailTemplateId: type: string format: uuid maximumTimeToSendEmailInHours: type: integer minimumTimeToSendEmailInHours: type: integer enabled: type: boolean EmailSecurityType: type: string enum: - NONE - SSL - TLS EmailTemplate: description: Stores an email template used to send emails to users. type: object properties: defaultFromName: type: string defaultHtmlTemplate: type: string defaultSubject: type: string defaultTextTemplate: type: string fromEmail: type: string id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" localizedFromNames: "$ref": "#/components/schemas/LocalizedStrings" localizedHtmlTemplates: "$ref": "#/components/schemas/LocalizedStrings" localizedSubjects: "$ref": "#/components/schemas/LocalizedStrings" localizedTextTemplates: "$ref": "#/components/schemas/LocalizedStrings" name: type: string EmailTemplateErrors: type: object properties: parseErrors: type: object additionalProperties: type: string renderErrors: type: object additionalProperties: type: string EmailTemplateRequest: description: Email template request. type: object properties: emailTemplate: "$ref": "#/components/schemas/EmailTemplate" EmailTemplateResponse: description: Email template response. type: object properties: emailTemplate: "$ref": "#/components/schemas/EmailTemplate" emailTemplates: type: array items: "$ref": "#/components/schemas/EmailTemplate" EmailTemplateSearchCriteria: description: Search criteria for Email templates type: object properties: name: type: string numberOfResults: type: integer orderBy: type: string startRow: type: integer EmailTemplateSearchRequest: description: Search request for email templates type: object properties: search: "$ref": "#/components/schemas/EmailTemplateSearchCriteria" EmailTemplateSearchResponse: description: Email template search response type: object properties: emailTemplates: type: array items: "$ref": "#/components/schemas/EmailTemplate" total: type: integer format: int64 EmailUnverifiedOptions: description: '' type: object properties: allowEmailChangeWhenGated: type: boolean behavior: "$ref": "#/components/schemas/UnverifiedBehavior" Enableable: description: Something that can be enabled and thus also disabled. type: object properties: enabled: type: boolean Entity: description: Models an entity that a user can be granted permissions to. Or an entity that can be granted permissions to another entity. type: object properties: data: type: object additionalProperties: type: object clientId: type: string clientSecret: type: string id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string parentId: type: string format: uuid tenantId: type: string format: uuid type: "$ref": "#/components/schemas/EntityType" EntityGrant: description: A grant for an entity to a user or another entity. type: object properties: data: type: object additionalProperties: type: object entity: "$ref": "#/components/schemas/Entity" id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" permissions: type: array uniqueItems: true items: {} recipientEntityId: type: string format: uuid userId: type: string format: uuid EntityGrantRequest: description: Entity grant API request object. type: object properties: grant: "$ref": "#/components/schemas/EntityGrant" EntityGrantResponse: description: Entity grant API response object. type: object properties: grants: type: array items: "$ref": "#/components/schemas/EntityGrant" grant: "$ref": "#/components/schemas/EntityGrant" EntityGrantSearchCriteria: description: Search criteria for entity grants. type: object properties: entityId: type: string format: uuid name: type: string userId: type: string format: uuid numberOfResults: type: integer orderBy: type: string startRow: type: integer EntityGrantSearchRequest: description: Search request for entity grants. type: object properties: search: "$ref": "#/components/schemas/EntityGrantSearchCriteria" EntityGrantSearchResponse: description: Search request for entity grants. type: object properties: grants: type: array items: "$ref": "#/components/schemas/EntityGrant" total: type: integer format: int64 EntityJWTConfiguration: description: JWT Configuration for entities. type: object properties: accessTokenKeyId: type: string format: uuid timeToLiveInSeconds: type: integer enabled: type: boolean EntityRequest: description: Entity API request object. type: object properties: entity: "$ref": "#/components/schemas/Entity" EntityResponse: description: Entity API response object. type: object properties: entity: "$ref": "#/components/schemas/Entity" EntitySearchCriteria: description: This class is the entity query. It provides a build pattern as well as public fields for use on forms and in actions. type: object properties: accurateTotal: type: boolean ids: type: array items: type: string format: uuid nextResults: type: string query: type: string queryString: type: string sortFields: type: array items: "$ref": "#/components/schemas/SortField" EntitySearchRequest: description: Search request for entities type: object properties: search: "$ref": "#/components/schemas/EntitySearchCriteria" EntitySearchResponse: description: Search request for entities type: object properties: entities: type: array items: "$ref": "#/components/schemas/Entity" nextResults: type: string total: type: integer format: int64 EntityType: description: Models an entity type that has a specific set of permissions. These are global objects and can be used across tenants. type: object properties: data: type: object additionalProperties: type: object id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" jwtConfiguration: "$ref": "#/components/schemas/EntityJWTConfiguration" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string permissions: type: array items: "$ref": "#/components/schemas/EntityTypePermission" EntityTypePermission: description: Models a specific entity type permission. This permission can be granted to users or other entities. type: object properties: data: type: object additionalProperties: type: object description: type: string id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" isDefault: type: boolean lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string EntityTypeRequest: description: Entity Type API request object. type: object properties: entityType: "$ref": "#/components/schemas/EntityType" permission: "$ref": "#/components/schemas/EntityTypePermission" EntityTypeResponse: description: Entity Type API response object. type: object properties: entityType: "$ref": "#/components/schemas/EntityType" entityTypes: type: array items: "$ref": "#/components/schemas/EntityType" permission: "$ref": "#/components/schemas/EntityTypePermission" EntityTypeSearchCriteria: description: Search criteria for entity types. type: object properties: name: type: string numberOfResults: type: integer orderBy: type: string startRow: type: integer EntityTypeSearchRequest: description: Search request for entity types. type: object properties: search: "$ref": "#/components/schemas/EntityTypeSearchCriteria" EntityTypeSearchResponse: description: Search response for entity types. type: object properties: entityTypes: type: array items: "$ref": "#/components/schemas/EntityType" total: type: integer format: int64 EpicGamesApplicationConfiguration: description: '' type: object properties: buttonText: type: string client_id: type: string client_secret: type: string scope: type: string data: type: object additionalProperties: type: object createRegistration: type: boolean EpicGamesIdentityProvider: description: Epic gaming login provider. type: object properties: buttonText: type: string client_id: type: string client_secret: type: string scope: type: string data: type: object additionalProperties: type: object applicationConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/EpicGamesApplicationConfiguration" debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lambdaConfiguration: "$ref": "#/components/schemas/ProviderLambdaConfiguration" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" linkingStrategy: "$ref": "#/components/schemas/IdentityProviderLinkingStrategy" name: type: string tenantConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/IdentityProviderTenantConfiguration" type: "$ref": "#/components/schemas/IdentityProviderType" Error: description: Defines an error. type: object properties: code: type: string data: type: object additionalProperties: type: object message: type: string Errors: description: Standard error domain object that can also be used as the response from an API call. type: object properties: fieldErrors: type: array items: "$ref": "#/components/schemas/Error" generalErrors: type: array items: "$ref": "#/components/schemas/Error" EventConfiguration: description: '' type: object properties: events: type: object additionalProperties: "$ref": "#/components/schemas/EventConfigurationData" EventConfigurationData: type: object properties: transactionType: "$ref": "#/components/schemas/TransactionType" enabled: type: boolean EventInfo: description: Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc). type: object properties: data: type: object additionalProperties: type: object deviceDescription: type: string deviceName: type: string deviceType: type: string ipAddress: type: string location: "$ref": "#/components/schemas/Location" os: type: string userAgent: type: string EventLog: description: Event log used internally by FusionAuth to help developers debug hooks, Webhooks, email templates, etc. type: object properties: id: type: integer format: int64 insertInstant: "$ref": "#/components/schemas/ZonedDateTime" message: type: string type: "$ref": "#/components/schemas/EventLogType" EventLogConfiguration: type: object properties: numberToRetain: type: integer EventLogCreateEvent: description: An Event "event" to indicate an event log was created. type: object properties: eventLog: "$ref": "#/components/schemas/EventLog" createInstant: "$ref": "#/components/schemas/ZonedDateTime" id: type: string format: uuid info: "$ref": "#/components/schemas/EventInfo" tenantId: type: string format: uuid type: "$ref": "#/components/schemas/EventType" EventLogResponse: description: Event log response. type: object properties: eventLog: "$ref": "#/components/schemas/EventLog" EventLogSearchCriteria: description: Search criteria for the event log. type: object properties: end: "$ref": "#/components/schemas/ZonedDateTime" message: type: string start: "$ref": "#/components/schemas/ZonedDateTime" type: "$ref": "#/components/schemas/EventLogType" numberOfResults: type: integer orderBy: type: string startRow: type: integer EventLogSearchRequest: description: '' type: object properties: search: "$ref": "#/components/schemas/EventLogSearchCriteria" EventLogSearchResponse: description: Event log response. type: object properties: eventLogs: type: array items: "$ref": "#/components/schemas/EventLog" total: type: integer format: int64 EventLogType: description: Event Log Type type: string enum: - Information - Debug - Error EventRequest: description: Container for the event information. This is the JSON that is sent from FusionAuth to webhooks. type: object properties: event: "$ref": "#/components/schemas/BaseEvent" EventType: description: Models the event types that FusionAuth produces. type: string enum: - JWTPublicKeyUpdate - JWTRefreshTokenRevoke - JWTRefresh - AuditLogCreate - EventLogCreate - KickstartSuccess - GroupCreate - GroupCreateComplete - GroupDelete - GroupDeleteComplete - GroupMemberAdd - GroupMemberAddComplete - GroupMemberRemove - GroupMemberRemoveComplete - GroupMemberUpdate - GroupMemberUpdateComplete - GroupUpdate - GroupUpdateComplete - UserAction - UserBulkCreate - UserCreate - UserCreateComplete - UserDeactivate - UserDelete - UserDeleteComplete - UserEmailUpdate - UserEmailVerified - UserIdentityProviderLink - UserIdentityProviderUnlink - UserLoginIdDuplicateOnCreate - UserLoginIdDuplicateOnUpdate - UserLoginFailed - UserLoginNewDevice - UserLoginSuccess - UserLoginSuspicious - UserPasswordBreach - UserPasswordResetSend - UserPasswordResetStart - UserPasswordResetSuccess - UserPasswordUpdate - UserReactivate - UserRegistrationCreate - UserRegistrationCreateComplete - UserRegistrationDelete - UserRegistrationDeleteComplete - UserRegistrationUpdate - UserRegistrationUpdateComplete - UserRegistrationVerified - UserTwoFactorMethodAdd - UserTwoFactorMethodRemove - UserUpdate - UserUpdateComplete - Test ExpandableRequest: description: An expandable API request. type: object properties: expand: type: array items: type: string ExpandableResponse: description: An expandable API response. type: object properties: expandable: type: array items: type: string ExpiryUnit: description: '' type: string enum: - MINUTES - HOURS - DAYS - WEEKS - MONTHS - YEARS ExternalIdentifierConfiguration: description: '' type: object properties: authorizationGrantIdTimeToLiveInSeconds: type: integer changePasswordIdGenerator: "$ref": "#/components/schemas/SecureGeneratorConfiguration" changePasswordIdTimeToLiveInSeconds: type: integer deviceCodeTimeToLiveInSeconds: type: integer deviceUserCodeIdGenerator: "$ref": "#/components/schemas/SecureGeneratorConfiguration" emailVerificationIdGenerator: "$ref": "#/components/schemas/SecureGeneratorConfiguration" emailVerificationIdTimeToLiveInSeconds: type: integer emailVerificationOneTimeCodeGenerator: "$ref": "#/components/schemas/SecureGeneratorConfiguration" externalAuthenticationIdTimeToLiveInSeconds: type: integer loginIntentTimeToLiveInSeconds: type: integer oneTimePasswordTimeToLiveInSeconds: type: integer passwordlessLoginGenerator: "$ref": "#/components/schemas/SecureGeneratorConfiguration" passwordlessLoginTimeToLiveInSeconds: type: integer pendingAccountLinkTimeToLiveInSeconds: type: integer registrationVerificationIdGenerator: "$ref": "#/components/schemas/SecureGeneratorConfiguration" registrationVerificationIdTimeToLiveInSeconds: type: integer registrationVerificationOneTimeCodeGenerator: "$ref": "#/components/schemas/SecureGeneratorConfiguration" rememberOAuthScopeConsentChoiceTimeToLiveInSeconds: type: integer samlv2AuthNRequestIdTimeToLiveInSeconds: type: integer setupPasswordIdGenerator: "$ref": "#/components/schemas/SecureGeneratorConfiguration" setupPasswordIdTimeToLiveInSeconds: type: integer trustTokenTimeToLiveInSeconds: type: integer twoFactorIdTimeToLiveInSeconds: type: integer twoFactorOneTimeCodeIdGenerator: "$ref": "#/components/schemas/SecureGeneratorConfiguration" twoFactorOneTimeCodeIdTimeToLiveInSeconds: type: integer twoFactorTrustIdTimeToLiveInSeconds: type: integer webAuthnAuthenticationChallengeTimeToLiveInSeconds: type: integer webAuthnRegistrationChallengeTimeToLiveInSeconds: type: integer ExternalJWTApplicationConfiguration: description: '' type: object properties: data: type: object additionalProperties: type: object createRegistration: type: boolean ExternalJWTIdentityProvider: description: External JWT-only identity provider. type: object properties: claimMap: type: object additionalProperties: type: string domains: type: array uniqueItems: true items: {} defaultKeyId: type: string format: uuid headerKeyParameter: type: string oauth2: "$ref": "#/components/schemas/IdentityProviderOauth2Configuration" uniqueIdentityClaim: type: string data: type: object additionalProperties: type: object applicationConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/ExternalJWTApplicationConfiguration" debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lambdaConfiguration: "$ref": "#/components/schemas/ProviderLambdaConfiguration" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" linkingStrategy: "$ref": "#/components/schemas/IdentityProviderLinkingStrategy" name: type: string tenantConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/IdentityProviderTenantConfiguration" type: "$ref": "#/components/schemas/IdentityProviderType" FacebookApplicationConfiguration: description: '' type: object properties: appId: type: string buttonText: type: string client_secret: type: string fields: type: string loginMethod: "$ref": "#/components/schemas/IdentityProviderLoginMethod" permissions: type: string data: type: object additionalProperties: type: object createRegistration: type: boolean FacebookIdentityProvider: description: Facebook social login provider. type: object properties: appId: type: string buttonText: type: string client_secret: type: string fields: type: string loginMethod: "$ref": "#/components/schemas/IdentityProviderLoginMethod" permissions: type: string data: type: object additionalProperties: type: object applicationConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/FacebookApplicationConfiguration" debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lambdaConfiguration: "$ref": "#/components/schemas/ProviderLambdaConfiguration" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" linkingStrategy: "$ref": "#/components/schemas/IdentityProviderLinkingStrategy" name: type: string tenantConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/IdentityProviderTenantConfiguration" type: "$ref": "#/components/schemas/IdentityProviderType" FailedAuthenticationActionCancelPolicy: description: A policy to configure if and when the user-action is canceled prior to the expiration of the action. type: object properties: onPasswordReset: type: boolean FailedAuthenticationConfiguration: description: Configuration for the behavior of failed login attempts. This helps us protect against brute force password attacks. type: object properties: actionCancelPolicy: "$ref": "#/components/schemas/FailedAuthenticationActionCancelPolicy" actionDuration: type: integer format: int64 actionDurationUnit: "$ref": "#/components/schemas/ExpiryUnit" emailUser: type: boolean resetCountInSeconds: type: integer tooManyAttempts: type: integer userActionId: type: string format: uuid Family: description: Models a family grouping of users. type: object properties: members: type: array items: "$ref": "#/components/schemas/FamilyMember" id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" FamilyConfiguration: description: '' type: object properties: allowChildRegistrations: type: boolean confirmChildEmailTemplateId: type: string format: uuid deleteOrphanedAccounts: type: boolean deleteOrphanedAccountsDays: type: integer familyRequestEmailTemplateId: type: string format: uuid maximumChildAge: type: integer minimumOwnerAge: type: integer parentEmailRequired: type: boolean parentRegistrationEmailTemplateId: type: string format: uuid enabled: type: boolean FamilyEmailRequest: description: API request for sending out family requests to parent's. type: object properties: parentEmail: type: string FamilyMember: description: Models a single family member. type: object properties: data: type: object additionalProperties: type: object insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" owner: type: boolean role: "$ref": "#/components/schemas/FamilyRole" userId: type: string format: uuid FamilyRequest: description: API request for managing families and members. type: object properties: familyMember: "$ref": "#/components/schemas/FamilyMember" FamilyResponse: description: API response for managing families and members. type: object properties: families: type: array items: "$ref": "#/components/schemas/Family" family: "$ref": "#/components/schemas/Family" FamilyRole: type: string enum: - Child - Teen - Adult ForgotPasswordRequest: description: Forgot password request object. type: object properties: applicationId: type: string format: uuid changePasswordId: type: string loginId: type: string sendForgotPasswordEmail: type: boolean state: type: object additionalProperties: type: object email: type: string username: type: string eventInfo: "$ref": "#/components/schemas/EventInfo" ForgotPasswordResponse: description: Forgot password response object. type: object properties: changePasswordId: type: string Form: description: '' type: object properties: data: type: object additionalProperties: type: object id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string steps: type: array items: "$ref": "#/components/schemas/FormStep" type: "$ref": "#/components/schemas/FormType" FormControl: description: '' type: string enum: - checkbox - number - password - radio - select - textarea - text FormDataType: description: '' type: string enum: - bool - consent - date - email - number - string FormField: description: '' type: object properties: confirm: type: boolean consentId: type: string format: uuid control: "$ref": "#/components/schemas/FormControl" data: type: object additionalProperties: type: object description: type: string id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" key: type: string lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string options: type: array items: type: string required: type: boolean type: "$ref": "#/components/schemas/FormDataType" validator: "$ref": "#/components/schemas/FormFieldValidator" FormFieldAdminPolicy: description: '' type: string enum: - Edit - View FormFieldRequest: description: The FormField API request object. type: object properties: field: "$ref": "#/components/schemas/FormField" fields: type: array items: "$ref": "#/components/schemas/FormField" FormFieldResponse: description: Form field response. type: object properties: field: "$ref": "#/components/schemas/FormField" fields: type: array items: "$ref": "#/components/schemas/FormField" FormFieldValidator: description: '' type: object properties: expression: type: string enabled: type: boolean FormRequest: description: Form response. type: object properties: form: "$ref": "#/components/schemas/Form" FormResponse: description: Form response. type: object properties: form: "$ref": "#/components/schemas/Form" forms: type: array items: "$ref": "#/components/schemas/Form" FormStep: description: '' type: object properties: fields: type: array items: type: string format: uuid FormType: description: '' type: string enum: - registration - adminRegistration - adminUser - selfServiceUser FusionAuthConnectorConfiguration: description: Models the FusionAuth connector. type: object properties: data: type: object additionalProperties: type: object debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string type: "$ref": "#/components/schemas/ConnectorType" GenericConnectorConfiguration: description: Models a generic connector. type: object properties: authenticationURL: type: string format: URI connectTimeout: type: integer headers: "$ref": "#/components/schemas/HTTPHeaders" httpAuthenticationPassword: type: string httpAuthenticationUsername: type: string readTimeout: type: integer sslCertificateKeyId: type: string format: uuid data: type: object additionalProperties: type: object debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string type: "$ref": "#/components/schemas/ConnectorType" GenericMessengerConfiguration: description: '' type: object properties: connectTimeout: type: integer headers: "$ref": "#/components/schemas/HTTPHeaders" httpAuthenticationPassword: type: string httpAuthenticationUsername: type: string readTimeout: type: integer sslCertificate: type: string url: type: string format: URI data: type: object additionalProperties: type: object debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string transport: type: string type: "$ref": "#/components/schemas/MessengerType" GoogleApplicationConfiguration: description: '' type: object properties: buttonText: type: string client_id: type: string client_secret: type: string loginMethod: "$ref": "#/components/schemas/IdentityProviderLoginMethod" properties: "$ref": "#/components/schemas/GoogleIdentityProviderProperties" scope: type: string data: type: object additionalProperties: type: object createRegistration: type: boolean GoogleIdentityProvider: description: Google social login provider. type: object properties: buttonText: type: string client_id: type: string client_secret: type: string loginMethod: "$ref": "#/components/schemas/IdentityProviderLoginMethod" properties: "$ref": "#/components/schemas/GoogleIdentityProviderProperties" scope: type: string data: type: object additionalProperties: type: object applicationConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/GoogleApplicationConfiguration" debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lambdaConfiguration: "$ref": "#/components/schemas/ProviderLambdaConfiguration" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" linkingStrategy: "$ref": "#/components/schemas/IdentityProviderLinkingStrategy" name: type: string tenantConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/IdentityProviderTenantConfiguration" type: "$ref": "#/components/schemas/IdentityProviderType" GoogleIdentityProviderProperties: description: Google social login provider parameters. type: object properties: api: type: string button: type: string GrantType: description: Authorization Grant types as defined by the The OAuth 2.0 Authorization Framework - RFC 6749.

Specific names as defined by OAuth 2.0 Dynamic Client Registration Protocol - RFC 7591 Section 4.1 type: string enum: - authorization_code - implicit - password - client_credentials - refresh_token - unknown - device_code Group: description: '' type: object properties: data: type: object additionalProperties: type: object id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string roles: type: array items: "$ref": "#/components/schemas/ApplicationRole" tenantId: type: string format: uuid GroupCreateCompleteEvent: description: Models the Group Created Event. type: object properties: group: "$ref": "#/components/schemas/Group" GroupCreateEvent: description: Models the Group Create Event. type: object properties: group: "$ref": "#/components/schemas/Group" GroupDeleteCompleteEvent: description: Models the Group Create Complete Event. type: object properties: group: "$ref": "#/components/schemas/Group" GroupDeleteEvent: description: Models the Group Delete Event. type: object properties: group: "$ref": "#/components/schemas/Group" GroupMember: description: A User's membership into a Group type: object properties: data: type: object additionalProperties: type: object groupId: type: string format: uuid id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" user: "$ref": "#/components/schemas/User" userId: type: string format: uuid GroupMemberAddCompleteEvent: description: Models the Group Member Add Complete Event. type: object properties: members: type: array items: "$ref": "#/components/schemas/GroupMember" group: "$ref": "#/components/schemas/Group" GroupMemberAddEvent: description: Models the Group Member Add Event. type: object properties: members: type: array items: "$ref": "#/components/schemas/GroupMember" group: "$ref": "#/components/schemas/Group" GroupMemberRemoveCompleteEvent: description: Models the Group Member Remove Complete Event. type: object properties: members: type: array items: "$ref": "#/components/schemas/GroupMember" group: "$ref": "#/components/schemas/Group" GroupMemberRemoveEvent: description: Models the Group Member Remove Event. type: object properties: members: type: array items: "$ref": "#/components/schemas/GroupMember" group: "$ref": "#/components/schemas/Group" GroupMemberSearchCriteria: description: Search criteria for Group Members type: object properties: groupId: type: string format: uuid tenantId: type: string format: uuid userId: type: string format: uuid numberOfResults: type: integer orderBy: type: string startRow: type: integer GroupMemberSearchRequest: description: Search request for Group Members. type: object properties: search: "$ref": "#/components/schemas/GroupMemberSearchCriteria" GroupMemberSearchResponse: description: Search response for Group Members type: object properties: members: type: array items: "$ref": "#/components/schemas/GroupMember" total: type: integer format: int64 GroupMemberUpdateCompleteEvent: description: Models the Group Member Update Complete Event. type: object properties: members: type: array items: "$ref": "#/components/schemas/GroupMember" group: "$ref": "#/components/schemas/Group" GroupMemberUpdateEvent: description: Models the Group Member Update Event. type: object properties: members: type: array items: "$ref": "#/components/schemas/GroupMember" group: "$ref": "#/components/schemas/Group" GroupRequest: description: Group API request object. type: object properties: group: "$ref": "#/components/schemas/Group" roleIds: type: array items: type: string format: uuid GroupResponse: description: Group API response object. type: object properties: group: "$ref": "#/components/schemas/Group" groups: type: array items: "$ref": "#/components/schemas/Group" GroupSearchCriteria: description: Search criteria for Groups type: object properties: name: type: string tenantId: type: string format: uuid numberOfResults: type: integer orderBy: type: string startRow: type: integer GroupSearchRequest: description: Search request for Groups. type: object properties: search: "$ref": "#/components/schemas/GroupSearchCriteria" GroupSearchResponse: description: Search response for Groups type: object properties: groups: type: array items: "$ref": "#/components/schemas/Group" total: type: integer format: int64 GroupUpdateCompleteEvent: description: Models the Group Update Complete Event. type: object properties: original: "$ref": "#/components/schemas/Group" group: "$ref": "#/components/schemas/Group" GroupUpdateEvent: description: Models the Group Update Event. type: object properties: original: "$ref": "#/components/schemas/Group" group: "$ref": "#/components/schemas/Group" HTTPHeaders: description: Type for webhook headers. type: object properties: {} HTTPMethod: description: '' type: string enum: - GET - POST - PUT - DELETE - HEAD - OPTIONS - PATCH HYPRApplicationConfiguration: description: '' type: object properties: relyingPartyApplicationId: type: string relyingPartyURL: type: string format: URI data: type: object additionalProperties: type: object createRegistration: type: boolean HYPRIdentityProvider: description: '' type: object properties: relyingPartyApplicationId: type: string relyingPartyURL: type: string format: URI data: type: object additionalProperties: type: object applicationConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/HYPRApplicationConfiguration" debug: type: boolean id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lambdaConfiguration: "$ref": "#/components/schemas/ProviderLambdaConfiguration" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" linkingStrategy: "$ref": "#/components/schemas/IdentityProviderLinkingStrategy" name: type: string tenantConfiguration: type: object additionalProperties: "$ref": "#/components/schemas/IdentityProviderTenantConfiguration" type: "$ref": "#/components/schemas/IdentityProviderType" HistoryItem: type: object properties: actionerUserId: type: string format: uuid comment: type: string createInstant: "$ref": "#/components/schemas/ZonedDateTime" expiry: "$ref": "#/components/schemas/ZonedDateTime" IPAccessControlEntry: description: '' type: object properties: action: "$ref": "#/components/schemas/IPAccessControlEntryAction" endIPAddress: type: string startIPAddress: type: string IPAccessControlEntryAction: description: '' type: string enum: - Allow - Block IPAccessControlList: description: '' type: object properties: data: type: object additionalProperties: type: object entries: type: array items: "$ref": "#/components/schemas/IPAccessControlEntry" id: type: string format: uuid insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastUpdateInstant: "$ref": "#/components/schemas/ZonedDateTime" name: type: string IPAccessControlListRequest: description: '' type: object properties: ipAccessControlList: "$ref": "#/components/schemas/IPAccessControlList" IPAccessControlListResponse: description: '' type: object properties: ipAccessControlList: "$ref": "#/components/schemas/IPAccessControlList" ipAccessControlLists: type: array items: "$ref": "#/components/schemas/IPAccessControlList" IPAccessControlListSearchCriteria: description: '' type: object properties: name: type: string numberOfResults: type: integer orderBy: type: string startRow: type: integer IPAccessControlListSearchRequest: description: Search request for IP ACLs . type: object properties: search: "$ref": "#/components/schemas/IPAccessControlListSearchCriteria" IPAccessControlListSearchResponse: description: '' type: object properties: ipAccessControlLists: type: array items: "$ref": "#/components/schemas/IPAccessControlList" total: type: integer format: int64 IdentityProviderDetails: type: object properties: applicationIds: type: array items: type: string format: uuid id: type: string format: uuid idpEndpoint: type: string format: URI name: type: string oauth2: "$ref": "#/components/schemas/IdentityProviderOauth2Configuration" type: "$ref": "#/components/schemas/IdentityProviderType" IdentityProviderField: oneOf: - "$ref": "#/components/schemas/FacebookIdentityProvider" - "$ref": "#/components/schemas/TwitterIdentityProvider" - "$ref": "#/components/schemas/ExternalJWTIdentityProvider" - "$ref": "#/components/schemas/AppleIdentityProvider" - "$ref": "#/components/schemas/SteamIdentityProvider" - "$ref": "#/components/schemas/LinkedInIdentityProvider" - "$ref": "#/components/schemas/SAMLv2IdentityProvider" - "$ref": "#/components/schemas/SonyPSNIdentityProvider" - "$ref": "#/components/schemas/SAMLv2IdPInitiatedIdentityProvider" - "$ref": "#/components/schemas/OpenIdConnectIdentityProvider" - "$ref": "#/components/schemas/XboxIdentityProvider" - "$ref": "#/components/schemas/GoogleIdentityProvider" - "$ref": "#/components/schemas/HYPRIdentityProvider" - "$ref": "#/components/schemas/NintendoIdentityProvider" - "$ref": "#/components/schemas/TwitchIdentityProvider" - "$ref": "#/components/schemas/EpicGamesIdentityProvider" discriminator: propertyName: type mapping: Facebook: "#/components/schemas/FacebookIdentityProvider" Twitter: "#/components/schemas/TwitterIdentityProvider" ExternalJWT: "#/components/schemas/ExternalJWTIdentityProvider" Apple: "#/components/schemas/AppleIdentityProvider" Steam: "#/components/schemas/SteamIdentityProvider" LinkedIn: "#/components/schemas/LinkedInIdentityProvider" SAMLv2: "#/components/schemas/SAMLv2IdentityProvider" SonyPSN: "#/components/schemas/SonyPSNIdentityProvider" SAMLv2IdPInitiated: "#/components/schemas/SAMLv2IdPInitiatedIdentityProvider" OpenIdConnect: "#/components/schemas/OpenIdConnectIdentityProvider" Xbox: "#/components/schemas/XboxIdentityProvider" Google: "#/components/schemas/GoogleIdentityProvider" HYPR: "#/components/schemas/HYPRIdentityProvider" Nintendo: "#/components/schemas/NintendoIdentityProvider" Twitch: "#/components/schemas/TwitchIdentityProvider" EpicGames: "#/components/schemas/EpicGamesIdentityProvider" IdentityProviderLimitUserLinkingPolicy: description: '' type: object properties: maximumLinks: type: integer enabled: type: boolean IdentityProviderLink: description: '' type: object properties: data: type: object additionalProperties: type: object displayName: type: string identityProviderId: type: string format: uuid identityProviderName: type: string identityProviderType: "$ref": "#/components/schemas/IdentityProviderType" identityProviderUserId: type: string insertInstant: "$ref": "#/components/schemas/ZonedDateTime" lastLoginInstant: "$ref": "#/components/schemas/ZonedDateTime" tenantId: type: string format: uuid token: type: string userId: type: string format: uuid IdentityProviderLinkRequest: description: '' type: object properties: identityProviderLink: "$ref": "#/components/schemas/IdentityProviderLink" pendingIdPLinkId: type: string eventInfo: "$ref": "#/components/schemas/EventInfo" IdentityProviderLinkResponse: description: '' type: object properties: identityProviderLink: "$ref": "#/components/schemas/IdentityProviderLink" identityProviderLinks: type: array items: "$ref": "#/components/schemas/IdentityProviderLink" IdentityProviderLinkingStrategy: description: The IdP behavior when no user link has been made yet. type: string enum: - CreatePendingLink - Disabled - LinkAnonymously - LinkByEmail - LinkByEmailForExistingUser - LinkByUsername - LinkByUsernameForExistingUser - Unsupported IdentityProviderLoginMethod: description: '' type: string enum: - UsePopup - UseRedirect - UseVendorJavaScript IdentityProviderLoginRequest: description: Login API request object used for login to third-party systems (i.e. Login with Facebook). type: object properties: data: type: object additionalProperties: type: string identityProviderId: type: string format: uuid noLink: type: boolean encodedJWT: type: string applicationId: type: string format: uuid ipAddress: type: string metaData: "$ref": "#/components/schemas/MetaData" newDevice: type: boolean noJWT: type: boolean IdentityProviderOauth2Configuration: description: '' type: object properties: authorization_endpoint: type: string format: URI clientAuthenticationMethod: "$ref": "#/components/schemas/ClientAuthenticationMethod" client_id: type: string client_secret: type: string emailClaim: type: string emailVerifiedClaim: type: string issuer: type: string format: URI scope: type: string token_endpoint: type: string format: URI uniqueIdClaim: type: string userinfo_endpoint: type: string format: URI usernameClaim: type: string IdentityProviderPendingLinkResponse: description: '' type: object properties: identityProviderTenantConfiguration: "$ref": "#/components/schemas/IdentityProviderTenantConfiguration" linkCount: type: integer pendingIdPLink: "$ref": "#/components/schemas/PendingIdPLink" IdentityProviderRequest: description: '' type: object properties: identityProvider: "$ref": "#/components/schemas/IdentityProviderField" IdentityProviderResponse: description: '' type: object properties: identityProvider: "$ref": "#/components/schemas/IdentityProviderField" identityProviders: type: array items: "$ref": "#/components/schemas/IdentityProviderField" IdentityProviderSearchCriteria: description: Search criteria for Identity Providers. type: object properties: applicationId: type: string format: uuid name: type: string type: "$ref": "#/components/schemas/IdentityProviderType" numberOfResults: type: integer orderBy: type: string startRow: type: integer IdentityProviderSearchRequest: description: Search request for Identity Providers type: object properties: search: "$ref": "#/components/schemas/IdentityProviderSearchCriteria" IdentityProviderSearchResponse: description: Identity Provider response. type: object properties: identityProviders: type: array items: "$ref": "#/components/schemas/IdentityProviderField" total: type: integer format: int64 IdentityProviderStartLoginRequest: description: '' type: object properties: data: type: object additionalProperties: type: string identityProviderId: type: string format: uuid loginId: type: string state: type: object additionalProperties: type: object applicationId: type: string format: uuid ipAddress: type: string metaData: "$ref": "#/components/schemas/MetaData" newDevice: type: boolean noJWT: type: boolean IdentityProviderStartLoginResponse: description: '' type: object properties: code: type: string IdentityProviderTenantConfiguration: description: '' type: object properties: data: type: object additionalProperties: type: object limitUserLinkCount: "$ref": "#/components/schemas/IdentityProviderLimitUserLinkingPolicy" IdentityProviderType: description: '' type: string enum: - Apple - EpicGames - ExternalJWT - Facebook - Google - HYPR - LinkedIn - Nintendo - OpenIDConnect - SAMLv2 - SAMLv2IdPInitiated - SonyPSN - Steam - Twitch - Twitter - Xbox ImportRequest: description: Import request. type: object properties: encryptionScheme: type: string factor: type: integer users: type: array items: "$ref": "#/components/schemas/User" validateDbConstraints: type: boolean eventInfo: "$ref": "#/components/schemas/EventInfo" InstanceEvent: description: A marker interface indicating this event is not scoped to a tenant and will be sent to all webhooks. type: object properties: {} IntegrationRequest: description: The Integration Request type: object properties: integrations: "$ref": "#/components/schemas/Integrations" IntegrationResponse: description: The Integration Response type: object properties: integrations: "$ref": "#/components/schemas/Integrations" Integrations: description: Available Integrations type: object properties: cleanspeak: "$ref": "#/components/schemas/CleanSpeakConfiguration" kafka: "$ref": "#/components/schemas/KafkaConfiguration" IntrospectResponse: description: '' type: object properties: {} IssueResponse: description: '' type: object properties: refreshToken: type: string token: type: string JSONWebKey: description: A JSON Web Key as defined by RFC 7517 JSON Web Key (JWK) Section 4 and RFC 7518 JSON Web Algorithms (JWA). type: object properties: alg: "$ref": "#/components/schemas/Algorithm" crv: type: string d: type: string dp: type: string dq: type: string e: type: string kid: type: string kty: "$ref": "#/components/schemas/KeyType" "n": type: string other: type: object additionalProperties: type: object p: type: string q: type: string qi: type: string use: type: string x: type: string x5c: type: array items: type: string x5t: type: string x5t#S256: type: string "y": type: string JSONWebKeyInfoProvider: description: Interface for any object that can provide JSON Web key Information. type: object properties: {} JWKSResponse: description: '' type: object properties: keys: type: array items: "$ref": "#/components/schemas/JSONWebKey" JWT: description: 'JSON Web Token (JWT) as defined by RFC 7519. 

  From RFC
        7519 Section 1. Introduction:     The suggested pronunciation of JWT is the
        same as the English word "jot".  
  The JWT is not Thread-Safe and should
        not be re-used.'
      type: object
      properties:
        aud:
          type: object
        exp:
          "$ref": "#/components/schemas/ZonedDateTime"
        iat:
          "$ref": "#/components/schemas/ZonedDateTime"
        iss:
          type: string
        nbf:
          "$ref": "#/components/schemas/ZonedDateTime"
        otherClaims:
          type: object
          additionalProperties:
            type: object
        sub:
          type: string
        jti:
          type: string
    JWTConfiguration:
      description: JWT Configuration. A JWT Configuration for an Application may not
        be active if it is using the global configuration, the configuration  may
        be enabled = false.
      type: object
      properties:
        accessTokenKeyId:
          type: string
          format: uuid
        idTokenKeyId:
          type: string
          format: uuid
        refreshTokenExpirationPolicy:
          "$ref": "#/components/schemas/RefreshTokenExpirationPolicy"
        refreshTokenOneTimeUseConfiguration:
          "$ref": "#/components/schemas/RefreshTokenOneTimeUseConfiguration"
        refreshTokenRevocationPolicy:
          "$ref": "#/components/schemas/RefreshTokenRevocationPolicy"
        refreshTokenSlidingWindowConfiguration:
          "$ref": "#/components/schemas/RefreshTokenSlidingWindowConfiguration"
        refreshTokenTimeToLiveInMinutes:
          type: integer
        refreshTokenUsagePolicy:
          "$ref": "#/components/schemas/RefreshTokenUsagePolicy"
        timeToLiveInSeconds:
          type: integer
        enabled:
          type: boolean
    JWTPublicKeyUpdateEvent:
      description: Models the JWT public key Refresh Token Revoke Event. This event
        might be for a single  token, a user or an entire application.
      type: object
      properties:
        applicationIds:
          type: array
          uniqueItems: true
          items: {}
        createInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        id:
          type: string
          format: uuid
        info:
          "$ref": "#/components/schemas/EventInfo"
        tenantId:
          type: string
          format: uuid
        type:
          "$ref": "#/components/schemas/EventType"
    JWTRefreshEvent:
      description: Models the JWT Refresh Event. This event will be fired when a JWT
        is "refreshed" (generated) using a Refresh Token.
      type: object
      properties:
        applicationId:
          type: string
          format: uuid
        original:
          type: string
        refreshToken:
          type: string
        token:
          type: string
        userId:
          type: string
          format: uuid
        createInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        id:
          type: string
          format: uuid
        info:
          "$ref": "#/components/schemas/EventInfo"
        tenantId:
          type: string
          format: uuid
        type:
          "$ref": "#/components/schemas/EventType"
    JWTRefreshResponse:
      description: API response for refreshing a JWT with a Refresh Token.  
  Using
        a different response object from RefreshTokenResponse because the retrieve
        response will return an object for refreshToken, and this is a  string.
      type: object
      properties:
        refreshToken:
          type: string
        refreshTokenId:
          type: string
          format: uuid
        token:
          type: string
    JWTRefreshTokenRevokeEvent:
      description: Models the Refresh Token Revoke Event. This event might be for
        a single token, a user  or an entire application.
      type: object
      properties:
        applicationId:
          type: string
          format: uuid
        applicationTimeToLiveInSeconds:
          type: object
          additionalProperties:
            type: integer
        refreshToken:
          "$ref": "#/components/schemas/RefreshToken"
        user:
          "$ref": "#/components/schemas/User"
        userId:
          type: string
          format: uuid
        createInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        id:
          type: string
          format: uuid
        info:
          "$ref": "#/components/schemas/EventInfo"
        tenantId:
          type: string
          format: uuid
        type:
          "$ref": "#/components/schemas/EventType"
    JWTVendRequest:
      description: ''
      type: object
      properties:
        claims:
          type: object
          additionalProperties:
            type: object
        keyId:
          type: string
          format: uuid
        timeToLiveInSeconds:
          type: integer
    JWTVendResponse:
      description: ''
      type: object
      properties:
        token:
          type: string
    KafkaConfiguration:
      description: ''
      type: object
      properties:
        defaultTopic:
          type: string
        producer:
          type: object
          additionalProperties:
            type: string
        enabled:
          type: boolean
    KafkaMessengerConfiguration:
      description: ''
      type: object
      properties:
        defaultTopic:
          type: string
        producer:
          type: object
          additionalProperties:
            type: string
        data:
          type: object
          additionalProperties:
            type: object
        debug:
          type: boolean
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        name:
          type: string
        transport:
          type: string
        type:
          "$ref": "#/components/schemas/MessengerType"
    Key:
      description: Domain for a public key, key pair or an HMAC secret. This is used
        by KeyMaster to manage keys for JWTs, SAML, etc.
      type: object
      properties:
        algorithm:
          "$ref": "#/components/schemas/KeyAlgorithm"
        certificate:
          type: string
        certificateInformation:
          "$ref": "#/components/schemas/CertificateInformation"
        expirationInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        hasPrivateKey:
          type: boolean
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        issuer:
          type: string
        kid:
          type: string
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        length:
          type: integer
        name:
          type: string
        privateKey:
          type: string
        publicKey:
          type: string
        secret:
          type: string
        type:
          "$ref": "#/components/schemas/KeyType"
    KeyAlgorithm:
      type: string
      enum:
      - ES256
      - ES384
      - ES512
      - HS256
      - HS384
      - HS512
      - RS256
      - RS384
      - RS512
    KeyRequest:
      description: Key API request object.
      type: object
      properties:
        key:
          "$ref": "#/components/schemas/Key"
    KeyResponse:
      description: Key API response object.
      type: object
      properties:
        key:
          "$ref": "#/components/schemas/Key"
        keys:
          type: array
          items:
            "$ref": "#/components/schemas/Key"
    KeySearchCriteria:
      description: Search criteria for Keys
      type: object
      properties:
        algorithm:
          "$ref": "#/components/schemas/KeyAlgorithm"
        name:
          type: string
        type:
          "$ref": "#/components/schemas/KeyType"
        numberOfResults:
          type: integer
        orderBy:
          type: string
        startRow:
          type: integer
    KeySearchRequest:
      description: Search request for Keys
      type: object
      properties:
        search:
          "$ref": "#/components/schemas/KeySearchCriteria"
    KeySearchResponse:
      description: Key search response
      type: object
      properties:
        keys:
          type: array
          items:
            "$ref": "#/components/schemas/Key"
        total:
          type: integer
          format: int64
    KeyType:
      type: string
      enum:
      - EC
      - RSA
      - HMAC
    KeyUse:
      description: The use type of a key.
      type: string
      enum:
      - SignOnly
      - SignAndVerify
      - VerifyOnly
    KickstartSuccessEvent:
      description: Event to indicate kickstart has been successfully completed.
      type: object
      properties:
        instanceId:
          type: string
          format: uuid
        createInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        id:
          type: string
          format: uuid
        info:
          "$ref": "#/components/schemas/EventInfo"
        tenantId:
          type: string
          format: uuid
        type:
          "$ref": "#/components/schemas/EventType"
    LDAPConnectorConfiguration:
      description: Models an LDAP connector.
      type: object
      properties:
        authenticationURL:
          type: string
          format: URI
        baseStructure:
          type: string
        connectTimeout:
          type: integer
        identifyingAttribute:
          type: string
        lambdaConfiguration:
          "$ref": "#/components/schemas/ConnectorLambdaConfiguration"
        loginIdAttribute:
          type: string
        readTimeout:
          type: integer
        requestedAttributes:
          type: array
          items:
            type: string
        securityMethod:
          "$ref": "#/components/schemas/LDAPSecurityMethod"
        systemAccountDN:
          type: string
        systemAccountPassword:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        debug:
          type: boolean
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        name:
          type: string
        type:
          "$ref": "#/components/schemas/ConnectorType"
    LDAPSecurityMethod:
      type: string
      enum:
      - None
      - LDAPS
      - StartTLS
    Lambda:
      description: A JavaScript lambda function that is executed during certain events
        inside FusionAuth.
      type: object
      properties:
        body:
          type: string
        debug:
          type: boolean
        engineType:
          "$ref": "#/components/schemas/LambdaEngineType"
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        name:
          type: string
        type:
          "$ref": "#/components/schemas/LambdaType"
    LambdaConfiguration:
      type: object
      properties:
        accessTokenPopulateId:
          type: string
          format: uuid
        idTokenPopulateId:
          type: string
          format: uuid
        samlv2PopulateId:
          type: string
          format: uuid
        selfServiceRegistrationValidationId:
          type: string
          format: uuid
        userinfoPopulateId:
          type: string
          format: uuid
    LambdaEngineType:
      description: ''
      type: string
      enum:
      - GraalJS
      - Nashorn
    LambdaRequest:
      description: Lambda API request object.
      type: object
      properties:
        lambda:
          "$ref": "#/components/schemas/Lambda"
    LambdaResponse:
      description: Lambda API response object.
      type: object
      properties:
        lambda:
          "$ref": "#/components/schemas/Lambda"
        lambdas:
          type: array
          items:
            "$ref": "#/components/schemas/Lambda"
    LambdaSearchCriteria:
      description: Search criteria for Lambdas
      type: object
      properties:
        body:
          type: string
        name:
          type: string
        type:
          "$ref": "#/components/schemas/LambdaType"
        numberOfResults:
          type: integer
        orderBy:
          type: string
        startRow:
          type: integer
    LambdaSearchRequest:
      description: Search request for Lambdas
      type: object
      properties:
        search:
          "$ref": "#/components/schemas/LambdaSearchCriteria"
    LambdaSearchResponse:
      description: Lambda search response
      type: object
      properties:
        lambdas:
          type: array
          items:
            "$ref": "#/components/schemas/Lambda"
        total:
          type: integer
          format: int64
    LambdaType:
      description: The types of lambdas that indicate how they are invoked by FusionAuth.
      type: string
      enum:
      - JWTPopulate
      - OpenIDReconcile
      - SAMLv2Reconcile
      - SAMLv2Populate
      - AppleReconcile
      - ExternalJWTReconcile
      - FacebookReconcile
      - GoogleReconcile
      - HYPRReconcile
      - TwitterReconcile
      - LDAPConnectorReconcile
      - LinkedInReconcile
      - EpicGamesReconcile
      - NintendoReconcile
      - SonyPSNReconcile
      - SteamReconcile
      - TwitchReconcile
      - XboxReconcile
      - ClientCredentialsJWTPopulate
      - SCIMServerGroupRequestConverter
      - SCIMServerGroupResponseConverter
      - SCIMServerUserRequestConverter
      - SCIMServerUserResponseConverter
      - SelfServiceRegistrationValidation
      - UserInfoPopulate
      - LoginValidation
    LinkedInApplicationConfiguration:
      description: ''
      type: object
      properties:
        buttonText:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        scope:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        createRegistration:
          type: boolean
    LinkedInIdentityProvider:
      description: ''
      type: object
      properties:
        buttonText:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        scope:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        applicationConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/LinkedInApplicationConfiguration"
        debug:
          type: boolean
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lambdaConfiguration:
          "$ref": "#/components/schemas/ProviderLambdaConfiguration"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        linkingStrategy:
          "$ref": "#/components/schemas/IdentityProviderLinkingStrategy"
        name:
          type: string
        tenantConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/IdentityProviderTenantConfiguration"
        type:
          "$ref": "#/components/schemas/IdentityProviderType"
    LocalDate:
      description: A date without a time-zone in the ISO-8601 calendar system, such
        as 2007-12-03.
      example: '2007-12-03'
      pattern: "^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]$"
      type: string
    Locale:
      description: A Locale object represents a specific geographical, political,
        or cultural region.
      example: en_US
      type: string
    LocalizedIntegers:
      description: Models a set of localized Integers that can be stored as JSON.
      type: object
      properties: {}
    LocalizedStrings:
      description: Models a set of localized Strings that can be stored as JSON.
      type: object
      properties: {}
    Location:
      description: Location information. Useful for IP addresses and other displayable
        data objects.
      type: object
      properties:
        city:
          type: string
        country:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
        region:
          type: string
        zipcode:
          type: string
        displayString:
          type: string
    LogHistory:
      description: A historical state of a user log event. Since events can be modified,
        this stores the historical state.
      type: object
      properties:
        historyItems:
          type: array
          items:
            "$ref": "#/components/schemas/HistoryItem"
    LoginConfiguration:
      type: object
      properties:
        allowTokenRefresh:
          type: boolean
        generateRefreshTokens:
          type: boolean
        requireAuthentication:
          type: boolean
    LoginHintConfiguration:
      description: ''
      type: object
      properties:
        parameterName:
          type: string
        enabled:
          type: boolean
    LoginIdType:
      type: string
      enum:
      - email
      - username
    LoginPingRequest:
      description: Login Ping API request object.
      type: object
      properties:
        userId:
          type: string
          format: uuid
        applicationId:
          type: string
          format: uuid
        ipAddress:
          type: string
        metaData:
          "$ref": "#/components/schemas/MetaData"
        newDevice:
          type: boolean
        noJWT:
          type: boolean
    LoginPreventedResponse:
      description: The summary of the action that is preventing login to be returned
        on the login response.
      type: object
      properties:
        actionId:
          type: string
          format: uuid
        actionerUserId:
          type: string
          format: uuid
        expiry:
          "$ref": "#/components/schemas/ZonedDateTime"
        localizedName:
          type: string
        localizedOption:
          type: string
        localizedReason:
          type: string
        name:
          type: string
        option:
          type: string
        reason:
          type: string
        reasonCode:
          type: string
    LoginRecordConfiguration:
      type: object
      properties:
        delete:
          "$ref": "#/components/schemas/DeleteConfiguration"
    LoginRecordExportRequest:
      description: ''
      type: object
      properties:
        criteria:
          "$ref": "#/components/schemas/LoginRecordSearchCriteria"
        dateTimeSecondsFormat:
          type: string
        zoneId:
          "$ref": "#/components/schemas/ZoneId"
    LoginRecordSearchCriteria:
      description: ''
      type: object
      properties:
        applicationId:
          type: string
          format: uuid
        end:
          "$ref": "#/components/schemas/ZonedDateTime"
        start:
          "$ref": "#/components/schemas/ZonedDateTime"
        userId:
          type: string
          format: uuid
        numberOfResults:
          type: integer
        orderBy:
          type: string
        startRow:
          type: integer
    LoginRecordSearchRequest:
      description: ''
      type: object
      properties:
        retrieveTotal:
          type: boolean
        search:
          "$ref": "#/components/schemas/LoginRecordSearchCriteria"
    LoginRecordSearchResponse:
      description: A raw login record response
      type: object
      properties:
        logins:
          type: array
          items:
            "$ref": "#/components/schemas/DisplayableRawLogin"
        total:
          type: integer
          format: int64
    LoginReportResponse:
      description: Response for the login report.
      type: object
      properties:
        hourlyCounts:
          type: array
          items:
            "$ref": "#/components/schemas/Count"
        total:
          type: integer
          format: int64
    LoginRequest:
      description: Login API request object.
      type: object
      properties:
        loginId:
          type: string
        oneTimePassword:
          type: string
        password:
          type: string
        twoFactorTrustId:
          type: string
        applicationId:
          type: string
          format: uuid
        ipAddress:
          type: string
        metaData:
          "$ref": "#/components/schemas/MetaData"
        newDevice:
          type: boolean
        noJWT:
          type: boolean
    LoginResponse:
      description: ''
      type: object
      properties:
        actions:
          type: array
          items:
            "$ref": "#/components/schemas/LoginPreventedResponse"
        changePasswordId:
          type: string
        changePasswordReason:
          "$ref": "#/components/schemas/ChangePasswordReason"
        configurableMethods:
          type: array
          items:
            type: string
        emailVerificationId:
          type: string
        methods:
          type: array
          items:
            "$ref": "#/components/schemas/TwoFactorMethod"
        pendingIdPLinkId:
          type: string
        refreshToken:
          type: string
        refreshTokenId:
          type: string
          format: uuid
        registrationVerificationId:
          type: string
        state:
          type: object
          additionalProperties:
            type: object
        threatsDetected:
          type: array
          uniqueItems: true
          items: {}
        token:
          type: string
        tokenExpirationInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        trustToken:
          type: string
        twoFactorId:
          type: string
        twoFactorTrustId:
          type: string
        user:
          "$ref": "#/components/schemas/User"
    LogoutBehavior:
      description: ''
      type: string
      enum:
      - RedirectOnly
      - AllApplications
    LogoutRequest:
      description: Request for the Logout API that can be used as an alternative to
        URL parameters.
      type: object
      properties:
        global:
          type: boolean
        refreshToken:
          type: string
        eventInfo:
          "$ref": "#/components/schemas/EventInfo"
    LookupResponse:
      description: ''
      type: object
      properties:
        identityProvider:
          "$ref": "#/components/schemas/IdentityProviderDetails"
    ManagedFields:
      description: 'This class contains the managed fields that are also put into
        the database during FusionAuth setup.  
  Internal Note: These fields are
        also declared in SQL in order to bootstrap the system. These need to stay
        in sync.  Any changes to these fields needs to also be reflected in mysql.sql
        and postgresql.sql'
      type: object
      properties: {}
    MaximumPasswordAge:
      description: ''
      type: object
      properties:
        days:
          type: integer
        enabled:
          type: boolean
    MemberDeleteRequest:
      description: Group Member Delete Request
      type: object
      properties:
        memberIds:
          type: array
          items:
            type: string
            format: uuid
        members:
          type: array
          items:
            type: string
            format: uuid
    MemberRequest:
      description: Group Member Request
      type: object
      properties:
        members:
          type: array
          items:
            "$ref": "#/components/schemas/GroupMember"
    MemberResponse:
      description: Group Member Response
      type: object
      properties:
        members:
          type: array
          items:
            "$ref": "#/components/schemas/GroupMember"
    Message:
      description: ''
      type: object
      properties: {}
    MessageTemplate:
      description: Stores an message template used to distribute messages;
      type: object
      properties:
        data:
          type: object
          additionalProperties:
            type: object
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        name:
          type: string
        type:
          "$ref": "#/components/schemas/MessageType"
    MessageTemplateRequest:
      description: A Message Template Request to the API
      type: object
      properties:
        messageTemplate:
          "$ref": "#/components/schemas/MessageTemplate"
    MessageTemplateResponse:
      description: ''
      type: object
      properties:
        messageTemplate:
          "$ref": "#/components/schemas/MessageTemplate"
        messageTemplates:
          type: array
          items:
            "$ref": "#/components/schemas/MessageTemplate"
    MessageType:
      description: ''
      type: string
      enum:
      - SMS
    MessengerRequest:
      description: ''
      type: object
      properties:
        messenger:
          "$ref": "#/components/schemas/BaseMessengerConfiguration"
    MessengerResponse:
      description: ''
      type: object
      properties:
        messenger:
          "$ref": "#/components/schemas/BaseMessengerConfiguration"
        messengers:
          type: array
          items:
            "$ref": "#/components/schemas/BaseMessengerConfiguration"
    MessengerTransport:
      description: ''
      type: object
      properties: {}
    MessengerType:
      description: ''
      type: string
      enum:
      - Generic
      - Kafka
      - Twilio
    MetaData:
      type: object
      properties:
        data:
          type: object
          additionalProperties:
            type: object
        device:
          "$ref": "#/components/schemas/DeviceInfo"
        scopes:
          type: array
          uniqueItems: true
          items: {}
    MinimumPasswordAge:
      description: ''
      type: object
      properties:
        seconds:
          type: integer
        enabled:
          type: boolean
    MonthlyActiveUserReportResponse:
      description: Response for the daily active user report.
      type: object
      properties:
        monthlyActiveUsers:
          type: array
          items:
            "$ref": "#/components/schemas/Count"
        total:
          type: integer
          format: int64
    MultiFactorAuthenticatorMethod:
      type: object
      properties:
        algorithm:
          "$ref": "#/components/schemas/TOTPAlgorithm"
        codeLength:
          type: integer
        timeStep:
          type: integer
        enabled:
          type: boolean
    MultiFactorEmailMethod:
      type: object
      properties:
        templateId:
          type: string
          format: uuid
        enabled:
          type: boolean
    MultiFactorEmailTemplate:
      type: object
      properties:
        templateId:
          type: string
          format: uuid
    MultiFactorLoginPolicy:
      description: ''
      type: string
      enum:
      - Disabled
      - Enabled
      - Required
    MultiFactorSMSMethod:
      type: object
      properties:
        messengerId:
          type: string
          format: uuid
        templateId:
          type: string
          format: uuid
        enabled:
          type: boolean
    MultiFactorSMSTemplate:
      type: object
      properties:
        templateId:
          type: string
          format: uuid
    NintendoApplicationConfiguration:
      description: ''
      type: object
      properties:
        buttonText:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        emailClaim:
          type: string
        scope:
          type: string
        uniqueIdClaim:
          type: string
        usernameClaim:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        createRegistration:
          type: boolean
    NintendoIdentityProvider:
      description: Nintendo gaming login provider.
      type: object
      properties:
        buttonText:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        emailClaim:
          type: string
        scope:
          type: string
        uniqueIdClaim:
          type: string
        usernameClaim:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        applicationConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/NintendoApplicationConfiguration"
        debug:
          type: boolean
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lambdaConfiguration:
          "$ref": "#/components/schemas/ProviderLambdaConfiguration"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        linkingStrategy:
          "$ref": "#/components/schemas/IdentityProviderLinkingStrategy"
        name:
          type: string
        tenantConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/IdentityProviderTenantConfiguration"
        type:
          "$ref": "#/components/schemas/IdentityProviderType"
    NonTransactionalEvent:
      description: A marker interface indicating this event cannot be made transactional.
      type: object
      properties: {}
    OAuth2Configuration:
      description: ''
      type: object
      properties:
        authorizedOriginURLs:
          type: array
          items:
            type: string
            format: URI
        authorizedRedirectURLs:
          type: array
          items:
            type: string
            format: URI
        authorizedURLValidationPolicy:
          "$ref": "#/components/schemas/Oauth2AuthorizedURLValidationPolicy"
        clientAuthenticationPolicy:
          "$ref": "#/components/schemas/ClientAuthenticationPolicy"
        clientId:
          type: string
        clientSecret:
          type: string
        consentMode:
          "$ref": "#/components/schemas/OAuthScopeConsentMode"
        debug:
          type: boolean
        deviceVerificationURL:
          type: string
          format: URI
        enabledGrants:
          type: array
          uniqueItems: true
          items: {}
        generateRefreshTokens:
          type: boolean
        logoutBehavior:
          "$ref": "#/components/schemas/LogoutBehavior"
        logoutURL:
          type: string
          format: URI
        proofKeyForCodeExchangePolicy:
          "$ref": "#/components/schemas/ProofKeyForCodeExchangePolicy"
        providedScopePolicy:
          "$ref": "#/components/schemas/ProvidedScopePolicy"
        relationship:
          "$ref": "#/components/schemas/OAuthApplicationRelationship"
        requireClientAuthentication:
          type: boolean
        requireRegistration:
          type: boolean
        scopeHandlingPolicy:
          "$ref": "#/components/schemas/OAuthScopeHandlingPolicy"
        unknownScopePolicy:
          "$ref": "#/components/schemas/UnknownScopePolicy"
    OAuthApplicationRelationship:
      description: The application's relationship to the authorization server. First-party
        applications will be granted implicit permission for requested scopes.  Third-party
        applications will use the {@link OAuthScopeConsentMode} policy.
      type: string
      enum:
      - FirstParty
      - ThirdParty
    OAuthConfigurationResponse:
      description: ''
      type: object
      properties:
        httpSessionMaxInactiveInterval:
          type: integer
        logoutURL:
          type: string
          format: URI
        oauthConfiguration:
          "$ref": "#/components/schemas/OAuth2Configuration"
    OAuthError:
      description: ''
      type: object
      properties:
        change_password_id:
          type: string
        error_description:
          type: string
        error:
          "$ref": "#/components/schemas/OAuthErrorType"
        error_uri:
          type: string
        two_factor_methods:
          type: array
          items:
            "$ref": "#/components/schemas/TwoFactorMethod"
        error_reason:
          "$ref": "#/components/schemas/OAuthErrorReason"
        two_factor_id:
          type: string
    OAuthErrorReason:
      type: string
      enum:
      - auth_code_not_found
      - access_token_malformed
      - access_token_expired
      - access_token_unavailable_for_processing
      - access_token_failed_processing
      - access_token_invalid
      - access_token_required
      - refresh_token_not_found
      - refresh_token_type_not_supported
      - invalid_client_id
      - invalid_user_credentials
      - invalid_grant_type
      - invalid_origin
      - invalid_origin_opaque
      - invalid_pkce_code_verifier
      - invalid_pkce_code_challenge
      - invalid_pkce_code_challenge_method
      - invalid_redirect_uri
      - invalid_response_mode
      - invalid_response_type
      - invalid_id_token_hint
      - invalid_post_logout_redirect_uri
      - invalid_device_code
      - invalid_user_code
      - invalid_additional_client_id
      - invalid_target_entity_scope
      - invalid_entity_permission_scope
      - invalid_user_id
      - grant_type_disabled
      - missing_client_id
      - missing_client_secret
      - missing_code
      - missing_code_challenge
      - missing_code_verifier
      - missing_device_code
      - missing_grant_type
      - missing_redirect_uri
      - missing_refresh_token
      - missing_response_type
      - missing_token
      - missing_user_code
      - missing_user_id
      - missing_verification_uri
      - login_prevented
      - not_licensed
      - user_code_expired
      - user_expired
      - user_locked
      - user_not_found
      - client_authentication_missing
      - invalid_client_authentication_scheme
      - invalid_client_authentication
      - client_id_mismatch
      - change_password_administrative
      - change_password_breached
      - change_password_expired
      - change_password_validation
      - unknown
      - missing_required_scope
      - unknown_scope
      - consent_canceled
    OAuthErrorType:
      type: string
      enum:
      - invalid_request
      - invalid_client
      - invalid_grant
      - invalid_token
      - unauthorized_client
      - invalid_scope
      - server_error
      - unsupported_grant_type
      - unsupported_response_type
      - access_denied
      - change_password_required
      - not_licensed
      - two_factor_required
      - authorization_pending
      - expired_token
      - unsupported_token_type
    OAuthResponse:
      description: ''
      type: object
      properties: {}
    OAuthScopeConsentMode:
      description: Controls the policy for requesting user permission to grant access
        to requested scopes during an OAuth workflow  for a third-party application.
      type: string
      enum:
      - AlwaysPrompt
      - RememberDecision
      - NeverPrompt
    OAuthScopeHandlingPolicy:
      description: Controls the policy for whether OAuth workflows will more strictly
        adhere to the OAuth and OIDC specification  or run in backwards compatibility
        mode.
      type: string
      enum:
      - Compatibility
      - Strict
    Oauth2AuthorizedURLValidationPolicy:
      description: ''
      type: string
      enum:
      - AllowWildcards
      - ExactMatch
    ObjectIdentifiable:
      description: A marker interface indicating this event is an event that can supply
        a linked object Id.
      type: object
      properties: {}
    ObjectState:
      description: ''
      type: string
      enum:
      - Active
      - Inactive
      - PendingDelete
    OpenIdConfiguration:
      description: OpenID Connect Configuration as described by the OpenID  Provider
        Metadata.
      type: object
      properties:
        authorization_endpoint:
          type: string
        backchannel_logout_supported:
          type: boolean
        claims_supported:
          type: array
          items:
            type: string
        device_authorization_endpoint:
          type: string
        end_session_endpoint:
          type: string
        frontchannel_logout_supported:
          type: boolean
        grant_types_supported:
          type: array
          items:
            type: string
        id_token_signing_alg_values_supported:
          type: array
          items:
            type: string
        issuer:
          type: string
        jwks_uri:
          type: string
        response_modes_supported:
          type: array
          items:
            type: string
        response_types_supported:
          type: array
          items:
            type: string
        scopes_supported:
          type: array
          items:
            type: string
        subject_types_supported:
          type: array
          items:
            type: string
        token_endpoint:
          type: string
        token_endpoint_auth_methods_supported:
          type: array
          items:
            type: string
        userinfo_endpoint:
          type: string
        userinfo_signing_alg_values_supported:
          type: array
          items:
            type: string
    OpenIdConnectApplicationConfiguration:
      description: ''
      type: object
      properties:
        buttonImageURL:
          type: string
          format: URI
        buttonText:
          type: string
        oauth2:
          "$ref": "#/components/schemas/IdentityProviderOauth2Configuration"
        data:
          type: object
          additionalProperties:
            type: object
        createRegistration:
          type: boolean
    OpenIdConnectIdentityProvider:
      description: ''
      type: object
      properties:
        domains:
          type: array
          uniqueItems: true
          items: {}
        buttonImageURL:
          type: string
          format: URI
        buttonText:
          type: string
        oauth2:
          "$ref": "#/components/schemas/IdentityProviderOauth2Configuration"
        postRequest:
          type: boolean
        data:
          type: object
          additionalProperties:
            type: object
        applicationConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/OpenIdConnectApplicationConfiguration"
        debug:
          type: boolean
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lambdaConfiguration:
          "$ref": "#/components/schemas/ProviderLambdaConfiguration"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        linkingStrategy:
          "$ref": "#/components/schemas/IdentityProviderLinkingStrategy"
        name:
          type: string
        tenantConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/IdentityProviderTenantConfiguration"
        type:
          "$ref": "#/components/schemas/IdentityProviderType"
    PasswordBreachDetection:
      description: ''
      type: object
      properties:
        matchMode:
          "$ref": "#/components/schemas/BreachMatchMode"
        notifyUserEmailTemplateId:
          type: string
          format: uuid
        onLogin:
          "$ref": "#/components/schemas/BreachAction"
        enabled:
          type: boolean
    PasswordEncryptionConfiguration:
      description: Password Encryption Scheme Configuration
      type: object
      properties:
        encryptionScheme:
          type: string
        encryptionSchemeFactor:
          type: integer
        modifyEncryptionSchemeOnLogin:
          type: boolean
    PasswordValidationRules:
      description: ''
      type: object
      properties:
        breachDetection:
          "$ref": "#/components/schemas/PasswordBreachDetection"
        maxLength:
          type: integer
        minLength:
          type: integer
        rememberPreviousPasswords:
          "$ref": "#/components/schemas/RememberPreviousPasswords"
        requireMixedCase:
          type: boolean
        requireNonAlpha:
          type: boolean
        requireNumber:
          type: boolean
        validateOnLogin:
          type: boolean
    PasswordValidationRulesResponse:
      description: ''
      type: object
      properties:
        passwordValidationRules:
          "$ref": "#/components/schemas/PasswordValidationRules"
    PasswordlessConfiguration:
      type: object
      properties:
        enabled:
          type: boolean
    PasswordlessIdentityProvider:
      description: Interface for all identity providers that are passwordless and
        do not accept a password.
      type: object
      properties: {}
    PasswordlessLoginRequest:
      description: ''
      type: object
      properties:
        code:
          type: string
        twoFactorTrustId:
          type: string
        applicationId:
          type: string
          format: uuid
        ipAddress:
          type: string
        metaData:
          "$ref": "#/components/schemas/MetaData"
        newDevice:
          type: boolean
        noJWT:
          type: boolean
    PasswordlessSendRequest:
      description: ''
      type: object
      properties:
        applicationId:
          type: string
          format: uuid
        code:
          type: string
        loginId:
          type: string
        state:
          type: object
          additionalProperties:
            type: object
    PasswordlessStartRequest:
      description: ''
      type: object
      properties:
        applicationId:
          type: string
          format: uuid
        loginId:
          type: string
        state:
          type: object
          additionalProperties:
            type: object
    PasswordlessStartResponse:
      description: ''
      type: object
      properties:
        code:
          type: string
    PendingIdPLink:
      description: ''
      type: object
      properties:
        displayName:
          type: string
        email:
          type: string
        identityProviderId:
          type: string
          format: uuid
        identityProviderLinks:
          type: array
          items:
            "$ref": "#/components/schemas/IdentityProviderLink"
        identityProviderName:
          type: string
        identityProviderTenantConfiguration:
          "$ref": "#/components/schemas/IdentityProviderTenantConfiguration"
        identityProviderType:
          "$ref": "#/components/schemas/IdentityProviderType"
        identityProviderUserId:
          type: string
        user:
          "$ref": "#/components/schemas/User"
        username:
          type: string
    PendingResponse:
      description: ''
      type: object
      properties:
        users:
          type: array
          items:
            "$ref": "#/components/schemas/User"
    PreviewMessageTemplateRequest:
      description: ''
      type: object
      properties:
        locale:
          "$ref": "#/components/schemas/Locale"
        messageTemplate:
          "$ref": "#/components/schemas/MessageTemplate"
    PreviewMessageTemplateResponse:
      description: ''
      type: object
      properties:
        errors:
          "$ref": "#/components/schemas/Errors"
        message:
          "$ref": "#/components/schemas/SMSMessage"
    PreviewRequest:
      description: ''
      type: object
      properties:
        emailTemplate:
          "$ref": "#/components/schemas/EmailTemplate"
        locale:
          "$ref": "#/components/schemas/Locale"
    PreviewResponse:
      description: ''
      type: object
      properties:
        email:
          "$ref": "#/components/schemas/Email"
        errors:
          "$ref": "#/components/schemas/Errors"
    ProofKeyForCodeExchangePolicy:
      description: ''
      type: string
      enum:
      - Required
      - NotRequired
      - NotRequiredWhenUsingClientAuthentication
    ProvidedScopePolicy:
      description: The handling policy for scopes provided by FusionAuth
      type: object
      properties:
        address:
          "$ref": "#/components/schemas/Requirable"
        email:
          "$ref": "#/components/schemas/Requirable"
        phone:
          "$ref": "#/components/schemas/Requirable"
        profile:
          "$ref": "#/components/schemas/Requirable"
    ProviderLambdaConfiguration:
      type: object
      properties:
        reconcileId:
          type: string
          format: uuid
    PublicKeyCredentialCreationOptions:
      description: Allows the Relying Party to specify desired attributes of a new
        credential.
      type: object
      properties:
        attestation:
          "$ref": "#/components/schemas/AttestationConveyancePreference"
        authenticatorSelection:
          "$ref": "#/components/schemas/AuthenticatorSelectionCriteria"
        challenge:
          type: string
        excludeCredentials:
          type: array
          items:
            "$ref": "#/components/schemas/PublicKeyCredentialDescriptor"
        extensions:
          "$ref": "#/components/schemas/WebAuthnRegistrationExtensionOptions"
        pubKeyCredParams:
          type: array
          items:
            "$ref": "#/components/schemas/PublicKeyCredentialParameters"
        rp:
          "$ref": "#/components/schemas/PublicKeyCredentialRelyingPartyEntity"
        timeout:
          type: integer
          format: int64
        user:
          "$ref": "#/components/schemas/PublicKeyCredentialUserEntity"
    PublicKeyCredentialDescriptor:
      description: Contains attributes for the Relying Party to refer to an existing
        public key credential as an input parameter.
      type: object
      properties:
        id:
          type: string
        transports:
          type: array
          items:
            type: string
        type:
          "$ref": "#/components/schemas/PublicKeyCredentialType"
    PublicKeyCredentialEntity:
      description: Describes a user account or WebAuthn Relying Party associated with
        a public key credential
      type: object
      properties:
        name:
          type: string
    PublicKeyCredentialParameters:
      description: Supply information on credential type and algorithm to the authenticator.
      type: object
      properties:
        alg:
          "$ref": "#/components/schemas/CoseAlgorithmIdentifier"
        type:
          "$ref": "#/components/schemas/PublicKeyCredentialType"
    PublicKeyCredentialRelyingPartyEntity:
      description: Supply additional information about the Relying Party when creating
        a new credential
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    PublicKeyCredentialRequestOptions:
      description: Provides the authenticator with the data it needs to generate
        an assertion.
      type: object
      properties:
        allowCredentials:
          type: array
          items:
            "$ref": "#/components/schemas/PublicKeyCredentialDescriptor"
        challenge:
          type: string
        rpId:
          type: string
        timeout:
          type: integer
          format: int64
        userVerification:
          "$ref": "#/components/schemas/UserVerificationRequirement"
    PublicKeyCredentialType:
      description: Defines valid credential types. This is an extension point in the
        WebAuthn spec. The only defined value at this time is "public-key"
      type: string
      enum:
      - publicKey
    PublicKeyCredentialUserEntity:
      description: Supply additional information about the user account when creating
        a new credential
      type: object
      properties:
        displayName:
          type: string
        id:
          type: string
        name:
          type: string
    PublicKeyResponse:
      description: JWT Public Key Response Object
      type: object
      properties:
        publicKey:
          type: string
        publicKeys:
          type: object
          additionalProperties:
            type: string
    RateLimitedRequestConfiguration:
      description: ''
      type: object
      properties:
        limit:
          type: integer
        timePeriodInSeconds:
          type: integer
        enabled:
          type: boolean
    RateLimitedRequestType:
      description: ''
      type: string
      enum:
      - FailedLogin
      - ForgotPassword
      - SendEmailVerification
      - SendPasswordless
      - SendRegistrationVerification
      - SendTwoFactor
    RawLogin:
      description: Raw login information for each time a user logs into an application.
      type: object
      properties:
        applicationId:
          type: string
          format: uuid
        instant:
          "$ref": "#/components/schemas/ZonedDateTime"
        ipAddress:
          type: string
        userId:
          type: string
          format: uuid
    ReactorFeatureStatus:
      description: ''
      type: string
      enum:
      - ACTIVE
      - DISCONNECTED
      - PENDING
      - DISABLED
      - UNKNOWN
    ReactorMetrics:
      description: ''
      type: object
      properties:
        breachedPasswordMetrics:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/BreachedPasswordTenantMetric"
    ReactorMetricsResponse:
      description: ''
      type: object
      properties:
        metrics:
          "$ref": "#/components/schemas/ReactorMetrics"
    ReactorRequest:
      description: Request for managing FusionAuth Reactor and licenses.
      type: object
      properties:
        license:
          type: string
        licenseId:
          type: string
    ReactorResponse:
      description: ''
      type: object
      properties:
        status:
          "$ref": "#/components/schemas/ReactorStatus"
    ReactorStatus:
      description: ''
      type: object
      properties:
        advancedIdentityProviders:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        advancedLambdas:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        advancedMultiFactorAuthentication:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        advancedOAuthScopes:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        advancedOAuthScopesCustomScopes:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        advancedOAuthScopesThirdPartyApplications:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        advancedRegistration:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        applicationMultiFactorAuthentication:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        applicationThemes:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        breachedPasswordDetection:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        connectors:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        entityManagement:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        expiration:
          "$ref": "#/components/schemas/LocalDate"
        licenseAttributes:
          type: object
          additionalProperties:
            type: string
        licensed:
          type: boolean
        scimServer:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        threatDetection:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        webAuthn:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        webAuthnPlatformAuthenticators:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
        webAuthnRoamingAuthenticators:
          "$ref": "#/components/schemas/ReactorFeatureStatus"
    RecentLoginResponse:
      description: Response for the user login report.
      type: object
      properties:
        logins:
          type: array
          items:
            "$ref": "#/components/schemas/DisplayableRawLogin"
    RefreshRequest:
      description: ''
      type: object
      properties:
        refreshToken:
          type: string
        token:
          type: string
        eventInfo:
          "$ref": "#/components/schemas/EventInfo"
    RefreshResponse:
      description: ''
      type: object
      properties: {}
    RefreshToken:
      description: Models a JWT Refresh Token.
      type: object
      properties:
        applicationId:
          type: string
          format: uuid
        data:
          type: object
          additionalProperties:
            type: object
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        metaData:
          "$ref": "#/components/schemas/MetaData"
        startInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        tenantId:
          type: string
          format: uuid
        token:
          type: string
        userId:
          type: string
          format: uuid
    RefreshTokenExpirationPolicy:
      description: ''
      type: string
      enum:
      - Fixed
      - SlidingWindow
      - SlidingWindowWithMaximumLifetime
    RefreshTokenImportRequest:
      description: Refresh Token Import request.
      type: object
      properties:
        refreshTokens:
          type: array
          items:
            "$ref": "#/components/schemas/RefreshToken"
        validateDbConstraints:
          type: boolean
    RefreshTokenOneTimeUseConfiguration:
      description: Refresh token one-time use configuration. This configuration is
        utilized when the usage policy is  configured for one-time use.
      type: object
      properties:
        gracePeriodInSeconds:
          type: integer
    RefreshTokenResponse:
      description: API response for retrieving Refresh Tokens
      type: object
      properties:
        refreshToken:
          "$ref": "#/components/schemas/RefreshToken"
        refreshTokens:
          type: array
          items:
            "$ref": "#/components/schemas/RefreshToken"
    RefreshTokenRevocationPolicy:
      description: ''
      type: object
      properties:
        onLoginPrevented:
          type: boolean
        onMultiFactorEnable:
          type: boolean
        onOneTimeTokenReuse:
          type: boolean
        onPasswordChanged:
          type: boolean
    RefreshTokenRevokeRequest:
      description: Request for the Refresh Token API to revoke a refresh token rather
        than using the URL parameters.
      type: object
      properties:
        applicationId:
          type: string
          format: uuid
        token:
          type: string
        userId:
          type: string
          format: uuid
        eventInfo:
          "$ref": "#/components/schemas/EventInfo"
    RefreshTokenSlidingWindowConfiguration:
      description: ''
      type: object
      properties:
        maximumTimeToLiveInMinutes:
          type: integer
    RefreshTokenUsagePolicy:
      description: ''
      type: string
      enum:
      - Reusable
      - OneTimeUse
    RegistrationConfiguration:
      type: object
      properties:
        birthDate:
          "$ref": "#/components/schemas/Requirable"
        confirmPassword:
          type: boolean
        firstName:
          "$ref": "#/components/schemas/Requirable"
        formId:
          type: string
          format: uuid
        fullName:
          "$ref": "#/components/schemas/Requirable"
        lastName:
          "$ref": "#/components/schemas/Requirable"
        loginIdType:
          "$ref": "#/components/schemas/LoginIdType"
        middleName:
          "$ref": "#/components/schemas/Requirable"
        mobilePhone:
          "$ref": "#/components/schemas/Requirable"
        preferredLanguages:
          "$ref": "#/components/schemas/Requirable"
        type:
          "$ref": "#/components/schemas/RegistrationType"
        enabled:
          type: boolean
    RegistrationDeleteRequest:
      description: Registration delete API request object.
      type: object
      properties:
        eventInfo:
          "$ref": "#/components/schemas/EventInfo"
    RegistrationReportResponse:
      description: Response for the registration report.
      type: object
      properties:
        hourlyCounts:
          type: array
          items:
            "$ref": "#/components/schemas/Count"
        total:
          type: integer
          format: int64
    RegistrationRequest:
      description: Registration API request object.
      type: object
      properties:
        disableDomainBlock:
          type: boolean
        generateAuthenticationToken:
          type: boolean
        registration:
          "$ref": "#/components/schemas/UserRegistration"
        sendSetPasswordEmail:
          type: boolean
        skipRegistrationVerification:
          type: boolean
        skipVerification:
          type: boolean
        user:
          "$ref": "#/components/schemas/User"
        eventInfo:
          "$ref": "#/components/schemas/EventInfo"
    RegistrationResponse:
      description: Registration API request object.
      type: object
      properties:
        refreshToken:
          type: string
        refreshTokenId:
          type: string
          format: uuid
        registration:
          "$ref": "#/components/schemas/UserRegistration"
        registrationVerificationId:
          type: string
        registrationVerificationOneTimeCode:
          type: string
        token:
          type: string
        tokenExpirationInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        user:
          "$ref": "#/components/schemas/User"
    RegistrationType:
      type: string
      enum:
      - basic
      - advanced
    RegistrationUnverifiedOptions:
      description: ''
      type: object
      properties:
        behavior:
          "$ref": "#/components/schemas/UnverifiedBehavior"
    ReindexRequest:
      description: Reindex API request
      type: object
      properties:
        index:
          type: string
    ReloadRequest:
      description: ''
      type: object
      properties:
        names:
          type: array
          items:
            type: string
    RememberPreviousPasswords:
      description: ''
      type: object
      properties:
        count:
          type: integer
        enabled:
          type: boolean
    Requirable:
      description: Something that can be required and thus also optional. This currently
        extends Enableable because anything that is  requiredoptional is almost always
        enableable as well.
      type: object
      properties:
        required:
          type: boolean
        enabled:
          type: boolean
    RequiresCORSConfiguration:
      description: Interface describing the need for CORS configuration.
      type: object
      properties: {}
    ResidentKeyRequirement:
      description: Describes the Relying Party's requirements for client-side  discoverable
        credentials (formerly known as "resident keys")
      type: string
      enum:
      - discouraged
      - preferred
      - required
    SAMLLogoutBehavior:
      type: string
      enum:
      - AllParticipants
      - OnlyOriginator
    SAMLv2ApplicationConfiguration:
      description: ''
      type: object
      properties:
        buttonImageURL:
          type: string
          format: URI
        buttonText:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        createRegistration:
          type: boolean
    SAMLv2AssertionConfiguration:
      description: ''
      type: object
      properties:
        destination:
          "$ref": "#/components/schemas/SAMLv2DestinationAssertionConfiguration"
    SAMLv2AssertionDecryptionConfiguration:
      description: Configuration for encrypted assertions when acting as SAML Service
        Provider
      type: object
      properties:
        keyTransportDecryptionKeyId:
          type: string
          format: uuid
        enabled:
          type: boolean
    SAMLv2AssertionEncryptionConfiguration:
      type: object
      properties:
        digestAlgorithm:
          type: string
        encryptionAlgorithm:
          type: string
        keyLocation:
          type: string
        keyTransportAlgorithm:
          type: string
        keyTransportEncryptionKeyId:
          type: string
          format: uuid
        maskGenerationFunction:
          type: string
        enabled:
          type: boolean
    SAMLv2Configuration:
      type: object
      properties:
        assertionEncryptionConfiguration:
          "$ref": "#/components/schemas/SAMLv2AssertionEncryptionConfiguration"
        audience:
          type: string
        authorizedRedirectURLs:
          type: array
          items:
            type: string
            format: URI
        debug:
          type: boolean
        defaultVerificationKeyId:
          type: string
          format: uuid
        initiatedLogin:
          "$ref": "#/components/schemas/SAMLv2IdPInitiatedLoginConfiguration"
        issuer:
          type: string
        keyId:
          type: string
          format: uuid
        loginHintConfiguration:
          "$ref": "#/components/schemas/LoginHintConfiguration"
        logout:
          "$ref": "#/components/schemas/SAMLv2Logout"
        logoutURL:
          type: string
          format: URI
        requireSignedRequests:
          type: boolean
        xmlSignatureC14nMethod:
          "$ref": "#/components/schemas/CanonicalizationMethod"
        xmlSignatureLocation:
          "$ref": "#/components/schemas/XMLSignatureLocation"
        callbackURL:
          type: string
          format: URI
        enabled:
          type: boolean
    SAMLv2DestinationAssertionConfiguration:
      description: ''
      type: object
      properties:
        alternates:
          type: array
          items:
            type: string
        policy:
          "$ref": "#/components/schemas/SAMLv2DestinationAssertionPolicy"
    SAMLv2DestinationAssertionPolicy:
      description: ''
      type: string
      enum:
      - Enabled
      - Disabled
      - AllowAlternates
    SAMLv2IdPInitiatedApplicationConfiguration:
      description: ''
      type: object
      properties:
        data:
          type: object
          additionalProperties:
            type: object
        createRegistration:
          type: boolean
    SAMLv2IdPInitiatedIdentityProvider:
      description: SAML v2 IdP Initiated identity provider configuration.
      type: object
      properties:
        issuer:
          type: string
        assertionDecryptionConfiguration:
          "$ref": "#/components/schemas/SAMLv2AssertionDecryptionConfiguration"
        emailClaim:
          type: string
        keyId:
          type: string
          format: uuid
        uniqueIdClaim:
          type: string
        useNameIdForEmail:
          type: boolean
        usernameClaim:
          type: string
    SAMLv2IdPInitiatedLoginConfiguration:
      description: IdP Initiated login configuration
      type: object
      properties:
        nameIdFormat:
          type: string
        enabled:
          type: boolean
    SAMLv2IdentityProvider:
      description: SAML v2 identity provider configuration.
      type: object
      properties:
        domains:
          type: array
          uniqueItems: true
          items: {}
        assertionConfiguration:
          "$ref": "#/components/schemas/SAMLv2AssertionConfiguration"
        buttonImageURL:
          type: string
          format: URI
        buttonText:
          type: string
        idpEndpoint:
          type: string
          format: URI
        idpInitiatedConfiguration:
          "$ref": "#/components/schemas/SAMLv2IdpInitiatedConfiguration"
        issuer:
          type: string
        loginHintConfiguration:
          "$ref": "#/components/schemas/LoginHintConfiguration"
        nameIdFormat:
          type: string
        postRequest:
          type: boolean
        requestSigningKeyId:
          type: string
          format: uuid
        signRequest:
          type: boolean
        xmlSignatureC14nMethod:
          "$ref": "#/components/schemas/CanonicalizationMethod"
        assertionDecryptionConfiguration:
          "$ref": "#/components/schemas/SAMLv2AssertionDecryptionConfiguration"
        emailClaim:
          type: string
        keyId:
          type: string
          format: uuid
        uniqueIdClaim:
          type: string
        useNameIdForEmail:
          type: boolean
        usernameClaim:
          type: string
    SAMLv2IdpInitiatedConfiguration:
      description: Config for regular SAML IDP configurations that support IdP initiated
        requests
      type: object
      properties:
        issuer:
          type: string
        enabled:
          type: boolean
    SAMLv2Logout:
      type: object
      properties:
        behavior:
          "$ref": "#/components/schemas/SAMLLogoutBehavior"
        defaultVerificationKeyId:
          type: string
          format: uuid
        keyId:
          type: string
          format: uuid
        requireSignedRequests:
          type: boolean
        singleLogout:
          "$ref": "#/components/schemas/SAMLv2SingleLogout"
        xmlSignatureC14nMethod:
          "$ref": "#/components/schemas/CanonicalizationMethod"
    SAMLv2SingleLogout:
      type: object
      properties:
        keyId:
          type: string
          format: uuid
        url:
          type: string
          format: URI
        xmlSignatureC14nMethod:
          "$ref": "#/components/schemas/CanonicalizationMethod"
        enabled:
          type: boolean
    SMSMessage:
      description: ''
      type: object
      properties:
        phoneNumber:
          type: string
        textMessage:
          type: string
    SMSMessageTemplate:
      description: ''
      type: object
      properties:
        defaultTemplate:
          type: string
        localizedTemplates:
          "$ref": "#/components/schemas/LocalizedStrings"
    SearchRequest:
      description: Search API request.
      type: object
      properties:
        search:
          "$ref": "#/components/schemas/UserSearchCriteria"
        expand:
          type: array
          items:
            type: string
    SearchResponse:
      description: Search API response.
      type: object
      properties:
        total:
          type: integer
          format: int64
        nextResults:
          type: string
        users:
          type: array
          items:
            "$ref": "#/components/schemas/User"
        expandable:
          type: array
          items:
            type: string
    SearchResults:
      description: Search results.
      type: object
      properties:
        nextResults:
          type: string
        results:
          type: array
          items:
            type: object
        total:
          type: integer
          format: int64
        totalEqualToActual:
          type: boolean
    SecretResponse:
      description: ''
      type: object
      properties:
        secret:
          type: string
        secretBase32Encoded:
          type: string
    SecureGeneratorConfiguration:
      description: ''
      type: object
      properties:
        length:
          type: integer
        type:
          "$ref": "#/components/schemas/SecureGeneratorType"
    SecureGeneratorType:
      description: ''
      type: string
      enum:
      - randomDigits
      - randomBytes
      - randomAlpha
      - randomAlphaNumeric
    SecureIdentity:
      description: ''
      type: object
      properties:
        breachedPasswordLastCheckedInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        breachedPasswordStatus:
          "$ref": "#/components/schemas/BreachedPasswordStatus"
        connectorId:
          type: string
          format: uuid
        encryptionScheme:
          type: string
        factor:
          type: integer
        id:
          type: string
          format: uuid
        lastLoginInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        password:
          type: string
        passwordChangeReason:
          "$ref": "#/components/schemas/ChangePasswordReason"
        passwordChangeRequired:
          type: boolean
        passwordLastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        salt:
          type: string
        uniqueUsername:
          type: string
        username:
          type: string
        usernameStatus:
          "$ref": "#/components/schemas/ContentStatus"
        verified:
          type: boolean
        verifiedInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
    SelfServiceFormConfiguration:
      description: ''
      type: object
      properties:
        requireCurrentPasswordOnPasswordChange:
          type: boolean
    SendRequest:
      description: ''
      type: object
      properties:
        applicationId:
          type: string
          format: uuid
        bccAddresses:
          type: array
          items:
            type: string
        ccAddresses:
          type: array
          items:
            type: string
        preferredLanguages:
          type: array
          items:
            "$ref": "#/components/schemas/Locale"
        requestData:
          type: object
          additionalProperties:
            type: object
        toAddresses:
          type: array
          items:
            "$ref": "#/components/schemas/EmailAddress"
        userIds:
          type: array
          items:
            type: string
            format: uuid
    SendResponse:
      description: ''
      type: object
      properties:
        anonymousResults:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/EmailTemplateErrors"
        results:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/EmailTemplateErrors"
    SimpleThemeVariables:
      description: Theme object for values used in the css variables for simple themes.
      type: object
      properties:
        alertBackgroundColor:
          type: string
        alertFontColor:
          type: string
        backgroundImageURL:
          type: string
          format: URI
        backgroundSize:
          type: string
        borderRadius:
          type: string
        deleteButtonColor:
          type: string
        deleteButtonFocusColor:
          type: string
        deleteButtonTextColor:
          type: string
        deleteButtonTextFocusColor:
          type: string
        errorFontColor:
          type: string
        errorIconColor:
          type: string
        fontColor:
          type: string
        fontFamily:
          type: string
        footerDisplay:
          type: boolean
        iconBackgroundColor:
          type: string
        iconColor:
          type: string
        infoIconColor:
          type: string
        inputBackgroundColor:
          type: string
        inputIconColor:
          type: string
        inputTextColor:
          type: string
        linkTextColor:
          type: string
        linkTextFocusColor:
          type: string
        logoImageSize:
          type: string
        logoImageURL:
          type: string
          format: URI
        monoFontColor:
          type: string
        monoFontFamily:
          type: string
        pageBackgroundColor:
          type: string
        panelBackgroundColor:
          type: string
        primaryButtonColor:
          type: string
        primaryButtonFocusColor:
          type: string
        primaryButtonTextColor:
          type: string
        primaryButtonTextFocusColor:
          type: string
    SonyPSNApplicationConfiguration:
      description: ''
      type: object
      properties:
        buttonText:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        scope:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        createRegistration:
          type: boolean
    SonyPSNIdentityProvider:
      description: SonyPSN gaming login provider.
      type: object
      properties:
        buttonText:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        scope:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        applicationConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/SonyPSNApplicationConfiguration"
        debug:
          type: boolean
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lambdaConfiguration:
          "$ref": "#/components/schemas/ProviderLambdaConfiguration"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        linkingStrategy:
          "$ref": "#/components/schemas/IdentityProviderLinkingStrategy"
        name:
          type: string
        tenantConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/IdentityProviderTenantConfiguration"
        type:
          "$ref": "#/components/schemas/IdentityProviderType"
    Sort:
      description: ''
      type: string
      enum:
      - asc
      - desc
    SortField:
      description: ''
      type: object
      properties:
        missing:
          type: string
        name:
          type: string
        order:
          "$ref": "#/components/schemas/Sort"
    StatusResponse:
      description: The public Status API response
      type: object
      properties: {}
    SteamAPIMode:
      description: Steam API modes.
      type: string
      enum:
      - Public
      - Partner
    SteamApplicationConfiguration:
      description: ''
      type: object
      properties:
        apiMode:
          "$ref": "#/components/schemas/SteamAPIMode"
        buttonText:
          type: string
        client_id:
          type: string
        scope:
          type: string
        webAPIKey:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        createRegistration:
          type: boolean
    SteamIdentityProvider:
      description: Steam gaming login provider.
      type: object
      properties:
        apiMode:
          "$ref": "#/components/schemas/SteamAPIMode"
        buttonText:
          type: string
        client_id:
          type: string
        scope:
          type: string
        webAPIKey:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        applicationConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/SteamApplicationConfiguration"
        debug:
          type: boolean
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lambdaConfiguration:
          "$ref": "#/components/schemas/ProviderLambdaConfiguration"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        linkingStrategy:
          "$ref": "#/components/schemas/IdentityProviderLinkingStrategy"
        name:
          type: string
        tenantConfiguration:
          type: object
          additionalProperties:
            "$ref": "#/components/schemas/IdentityProviderTenantConfiguration"
        type:
          "$ref": "#/components/schemas/IdentityProviderType"
    SupportsPostBindings:
      description: Helper interface that indicates an identity provider can be federated
        to using the HTTP POST method.
      type: object
      properties: {}
    SystemConfiguration:
      description: ''
      type: object
      properties:
        auditLogConfiguration:
          "$ref": "#/components/schemas/AuditLogConfiguration"
        corsConfiguration:
          "$ref": "#/components/schemas/CORSConfiguration"
        data:
          type: object
          additionalProperties:
            type: object
        eventLogConfiguration:
          "$ref": "#/components/schemas/EventLogConfiguration"
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        loginRecordConfiguration:
          "$ref": "#/components/schemas/LoginRecordConfiguration"
        reportTimezone:
          "$ref": "#/components/schemas/ZoneId"
        trustedProxyConfiguration:
          "$ref": "#/components/schemas/SystemTrustedProxyConfiguration"
        uiConfiguration:
          "$ref": "#/components/schemas/UIConfiguration"
        usageDataConfiguration:
          "$ref": "#/components/schemas/UsageDataConfiguration"
        webhookEventLogConfiguration:
          "$ref": "#/components/schemas/WebhookEventLogConfiguration"
    SystemConfigurationRequest:
      description: Request for the system configuration API.
      type: object
      properties:
        systemConfiguration:
          "$ref": "#/components/schemas/SystemConfiguration"
    SystemConfigurationResponse:
      description: Response for the system configuration API.
      type: object
      properties:
        systemConfiguration:
          "$ref": "#/components/schemas/SystemConfiguration"
    SystemLogsExportRequest:
      description: ''
      type: object
      properties:
        includeArchived:
          type: boolean
        lastNBytes:
          type: integer
        dateTimeSecondsFormat:
          type: string
        zoneId:
          "$ref": "#/components/schemas/ZoneId"
    SystemTrustedProxyConfiguration:
      description: ''
      type: object
      properties:
        trustPolicy:
          "$ref": "#/components/schemas/SystemTrustedProxyConfigurationPolicy"
        trusted:
          type: array
          items:
            type: string
    SystemTrustedProxyConfigurationPolicy:
      description: ''
      type: string
      enum:
      - All
      - OnlyConfigured
    TOTPAlgorithm:
      type: string
      enum:
      - HmacSHA1
      - HmacSHA256
      - HmacSHA512
    Templates:
      type: object
      properties:
        accountEdit:
          type: string
        accountIndex:
          type: string
        accountTwoFactorDisable:
          type: string
        accountTwoFactorEnable:
          type: string
        accountTwoFactorIndex:
          type: string
        accountWebAuthnAdd:
          type: string
        accountWebAuthnDelete:
          type: string
        accountWebAuthnIndex:
          type: string
        confirmationRequired:
          type: string
        emailComplete:
          type: string
        emailSent:
          type: string
        emailVerificationRequired:
          type: string
        emailVerify:
          type: string
        helpers:
          type: string
        index:
          type: string
        oauth2Authorize:
          type: string
        oauth2AuthorizedNotRegistered:
          type: string
        oauth2ChildRegistrationNotAllowed:
          type: string
        oauth2ChildRegistrationNotAllowedComplete:
          type: string
        oauth2CompleteRegistration:
          type: string
        oauth2Consent:
          type: string
        oauth2Device:
          type: string
        oauth2DeviceComplete:
          type: string
        oauth2Error:
          type: string
        oauth2Logout:
          type: string
        oauth2Passwordless:
          type: string
        oauth2Register:
          type: string
        oauth2StartIdPLink:
          type: string
        oauth2TwoFactor:
          type: string
        oauth2TwoFactorEnable:
          type: string
        oauth2TwoFactorEnableComplete:
          type: string
        oauth2TwoFactorMethods:
          type: string
        oauth2Wait:
          type: string
        oauth2WebAuthn:
          type: string
        oauth2WebAuthnReauth:
          type: string
        oauth2WebAuthnReauthEnable:
          type: string
        passwordChange:
          type: string
        passwordComplete:
          type: string
        passwordForgot:
          type: string
        passwordSent:
          type: string
        registrationComplete:
          type: string
        registrationSent:
          type: string
        registrationVerificationRequired:
          type: string
        registrationVerify:
          type: string
        samlv2Logout:
          type: string
        unauthorized:
          type: string
        emailSend:
          type: string
        registrationSend:
          type: string
    Tenant:
      description: ''
      type: object
      properties:
        data:
          type: object
          additionalProperties:
            type: object
        accessControlConfiguration:
          "$ref": "#/components/schemas/TenantAccessControlConfiguration"
        captchaConfiguration:
          "$ref": "#/components/schemas/TenantCaptchaConfiguration"
        configured:
          type: boolean
        connectorPolicies:
          type: array
          items:
            "$ref": "#/components/schemas/ConnectorPolicy"
        emailConfiguration:
          "$ref": "#/components/schemas/EmailConfiguration"
        eventConfiguration:
          "$ref": "#/components/schemas/EventConfiguration"
        externalIdentifierConfiguration:
          "$ref": "#/components/schemas/ExternalIdentifierConfiguration"
        failedAuthenticationConfiguration:
          "$ref": "#/components/schemas/FailedAuthenticationConfiguration"
        familyConfiguration:
          "$ref": "#/components/schemas/FamilyConfiguration"
        formConfiguration:
          "$ref": "#/components/schemas/TenantFormConfiguration"
        httpSessionMaxInactiveInterval:
          type: integer
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        issuer:
          type: string
        jwtConfiguration:
          "$ref": "#/components/schemas/JWTConfiguration"
        lambdaConfiguration:
          "$ref": "#/components/schemas/TenantLambdaConfiguration"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        loginConfiguration:
          "$ref": "#/components/schemas/TenantLoginConfiguration"
        logoutURL:
          type: string
          format: URI
        maximumPasswordAge:
          "$ref": "#/components/schemas/MaximumPasswordAge"
        minimumPasswordAge:
          "$ref": "#/components/schemas/MinimumPasswordAge"
        multiFactorConfiguration:
          "$ref": "#/components/schemas/TenantMultiFactorConfiguration"
        name:
          type: string
        oauthConfiguration:
          "$ref": "#/components/schemas/TenantOAuth2Configuration"
        passwordEncryptionConfiguration:
          "$ref": "#/components/schemas/PasswordEncryptionConfiguration"
        passwordValidationRules:
          "$ref": "#/components/schemas/PasswordValidationRules"
        rateLimitConfiguration:
          "$ref": "#/components/schemas/TenantRateLimitConfiguration"
        registrationConfiguration:
          "$ref": "#/components/schemas/TenantRegistrationConfiguration"
        scimServerConfiguration:
          "$ref": "#/components/schemas/TenantSCIMServerConfiguration"
        ssoConfiguration:
          "$ref": "#/components/schemas/TenantSSOConfiguration"
        state:
          "$ref": "#/components/schemas/ObjectState"
        themeId:
          type: string
          format: uuid
        userDeletePolicy:
          "$ref": "#/components/schemas/TenantUserDeletePolicy"
        usernameConfiguration:
          "$ref": "#/components/schemas/TenantUsernameConfiguration"
        webAuthnConfiguration:
          "$ref": "#/components/schemas/TenantWebAuthnConfiguration"
    TenantAccessControlConfiguration:
      description: ''
      type: object
      properties:
        uiIPAccessControlListId:
          type: string
          format: uuid
    TenantCaptchaConfiguration:
      description: ''
      type: object
      properties:
        captchaMethod:
          "$ref": "#/components/schemas/CaptchaMethod"
        secretKey:
          type: string
        siteKey:
          type: string
        threshold:
          type: number
          format: double
        enabled:
          type: boolean
    TenantDeleteRequest:
      description: Request for the Tenant API to delete a tenant rather than using
        the URL parameters.
      type: object
      properties:
        async:
          type: boolean
        eventInfo:
          "$ref": "#/components/schemas/EventInfo"
    TenantFormConfiguration:
      description: ''
      type: object
      properties:
        adminUserFormId:
          type: string
          format: uuid
    TenantLambdaConfiguration:
      description: ''
      type: object
      properties:
        loginValidationId:
          type: string
          format: uuid
        scimEnterpriseUserRequestConverterId:
          type: string
          format: uuid
        scimEnterpriseUserResponseConverterId:
          type: string
          format: uuid
        scimGroupRequestConverterId:
          type: string
          format: uuid
        scimGroupResponseConverterId:
          type: string
          format: uuid
        scimUserRequestConverterId:
          type: string
          format: uuid
        scimUserResponseConverterId:
          type: string
          format: uuid
    TenantLoginConfiguration:
      description: ''
      type: object
      properties:
        requireAuthentication:
          type: boolean
    TenantMultiFactorConfiguration:
      description: ''
      type: object
      properties:
        authenticator:
          "$ref": "#/components/schemas/MultiFactorAuthenticatorMethod"
        email:
          "$ref": "#/components/schemas/MultiFactorEmailMethod"
        loginPolicy:
          "$ref": "#/components/schemas/MultiFactorLoginPolicy"
        sms:
          "$ref": "#/components/schemas/MultiFactorSMSMethod"
    TenantOAuth2Configuration:
      type: object
      properties:
        clientCredentialsAccessTokenPopulateLambdaId:
          type: string
          format: uuid
    TenantRateLimitConfiguration:
      description: ''
      type: object
      properties:
        failedLogin:
          "$ref": "#/components/schemas/RateLimitedRequestConfiguration"
        forgotPassword:
          "$ref": "#/components/schemas/RateLimitedRequestConfiguration"
        sendEmailVerification:
          "$ref": "#/components/schemas/RateLimitedRequestConfiguration"
        sendPasswordless:
          "$ref": "#/components/schemas/RateLimitedRequestConfiguration"
        sendRegistrationVerification:
          "$ref": "#/components/schemas/RateLimitedRequestConfiguration"
        sendTwoFactor:
          "$ref": "#/components/schemas/RateLimitedRequestConfiguration"
    TenantRegistrationConfiguration:
      description: ''
      type: object
      properties:
        blockedDomains:
          type: array
          uniqueItems: true
          items: {}
    TenantRequest:
      description: ''
      type: object
      properties:
        sourceTenantId:
          type: string
          format: uuid
        tenant:
          "$ref": "#/components/schemas/Tenant"
        webhookIds:
          type: array
          items:
            type: string
            format: uuid
        eventInfo:
          "$ref": "#/components/schemas/EventInfo"
    TenantResponse:
      description: ''
      type: object
      properties:
        tenant:
          "$ref": "#/components/schemas/Tenant"
        tenants:
          type: array
          items:
            "$ref": "#/components/schemas/Tenant"
    TenantSCIMServerConfiguration:
      description: ''
      type: object
      properties:
        clientEntityTypeId:
          type: string
          format: uuid
        schemas:
          type: object
          additionalProperties:
            type: object
        serverEntityTypeId:
          type: string
          format: uuid
        enabled:
          type: boolean
    TenantSSOConfiguration:
      description: ''
      type: object
      properties:
        deviceTrustTimeToLiveInSeconds:
          type: integer
    TenantSearchCriteria:
      description: Search criteria for Tenants
      type: object
      properties:
        name:
          type: string
        numberOfResults:
          type: integer
        orderBy:
          type: string
        startRow:
          type: integer
    TenantSearchRequest:
      description: Search request for Tenants
      type: object
      properties:
        search:
          "$ref": "#/components/schemas/TenantSearchCriteria"
    TenantSearchResponse:
      description: Tenant search response
      type: object
      properties:
        tenants:
          type: array
          items:
            "$ref": "#/components/schemas/Tenant"
        total:
          type: integer
          format: int64
    TenantUnverifiedConfiguration:
      description: ''
      type: object
      properties:
        email:
          "$ref": "#/components/schemas/UnverifiedBehavior"
        whenGated:
          "$ref": "#/components/schemas/RegistrationUnverifiedOptions"
    TenantUserDeletePolicy:
      description: A Tenant-level policy for deleting Users.
      type: object
      properties:
        unverified:
          "$ref": "#/components/schemas/TimeBasedDeletePolicy"
    TenantUsernameConfiguration:
      description: ''
      type: object
      properties:
        unique:
          "$ref": "#/components/schemas/UniqueUsernameConfiguration"
    TenantWebAuthnConfiguration:
      description: Tenant-level configuration for WebAuthn
      type: object
      properties:
        bootstrapWorkflow:
          "$ref": "#/components/schemas/TenantWebAuthnWorkflowConfiguration"
        debug:
          type: boolean
        reauthenticationWorkflow:
          "$ref": "#/components/schemas/TenantWebAuthnWorkflowConfiguration"
        relyingPartyId:
          type: string
        relyingPartyName:
          type: string
        enabled:
          type: boolean
    TenantWebAuthnWorkflowConfiguration:
      description: ''
      type: object
      properties:
        authenticatorAttachmentPreference:
          "$ref": "#/components/schemas/AuthenticatorAttachmentPreference"
        userVerificationRequirement:
          "$ref": "#/components/schemas/UserVerificationRequirement"
        enabled:
          type: boolean
    Tenantable:
      description: ''
      type: object
      properties: {}
    TestEvent:
      description: ''
      type: object
      properties:
        message:
          type: string
        createInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        id:
          type: string
          format: uuid
        info:
          "$ref": "#/components/schemas/EventInfo"
        tenantId:
          type: string
          format: uuid
        type:
          "$ref": "#/components/schemas/EventType"
    Theme:
      description: ''
      type: object
      properties:
        data:
          type: object
          additionalProperties:
            type: object
        defaultMessages:
          type: string
        id:
          type: string
          format: uuid
        insertInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        lastUpdateInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        localizedMessages:
          "$ref": "#/components/schemas/LocalizedStrings"
        name:
          type: string
        stylesheet:
          type: string
        templates:
          "$ref": "#/components/schemas/Templates"
        type:
          "$ref": "#/components/schemas/ThemeType"
        variables:
          "$ref": "#/components/schemas/SimpleThemeVariables"
    ThemeRequest:
      description: Theme API request object.
      type: object
      properties:
        sourceThemeId:
          type: string
          format: uuid
        theme:
          "$ref": "#/components/schemas/Theme"
    ThemeResponse:
      description: Theme API response object.
      type: object
      properties:
        theme:
          "$ref": "#/components/schemas/Theme"
        themes:
          type: array
          items:
            "$ref": "#/components/schemas/Theme"
    ThemeSearchCriteria:
      description: Search criteria for themes
      type: object
      properties:
        name:
          type: string
        type:
          "$ref": "#/components/schemas/ThemeType"
        numberOfResults:
          type: integer
        orderBy:
          type: string
        startRow:
          type: integer
    ThemeSearchRequest:
      description: Search request for Themes.
      type: object
      properties:
        search:
          "$ref": "#/components/schemas/ThemeSearchCriteria"
    ThemeSearchResponse:
      description: Search response for Themes
      type: object
      properties:
        themes:
          type: array
          items:
            "$ref": "#/components/schemas/Theme"
        total:
          type: integer
          format: int64
    ThemeType:
      type: string
      enum:
      - advanced
      - simple
    TimeBasedDeletePolicy:
      description: A policy for deleting Users based upon some external criteria.
      type: object
      properties:
        enabledInstant:
          "$ref": "#/components/schemas/ZonedDateTime"
        numberOfDaysToRetain:
          type: integer
        enabled:
          type: boolean
    TokenType:
      description: