{"components":{"schemas":{"AppCreateSchema":{"properties":{"allowed_origins":{"items":{"type":"string"},"type":"array"},"allowed_scopes":{"items":{"type":"string"},"type":"array"},"client_secret":{"readOnly":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"default_user_id":{"format":"uuid","nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"oauth_client_type":{"default":null,"enum":["public","confidential"],"nullable":true,"type":"string"},"redirect_uris":{"items":{"type":"string"},"type":"array"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["PAT","OAUTH"],"type":"string"},"url":{"format":"url","nullable":true,"type":"string"}},"required":["name"],"type":"object"},"AppSchema":{"properties":{"allowed_origins":{"items":{"type":"string"},"type":"array"},"allowed_scopes":{"items":{"type":"string"},"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"default_user_id":{"format":"uuid","nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"oauth_client_type":{"default":null,"enum":["public","confidential"],"nullable":true,"type":"string"},"redirect_uris":{"items":{"type":"string"},"type":"array"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["PAT","OAUTH"],"readOnly":true,"type":"string"},"url":{"format":"url","nullable":true,"type":"string"}},"required":["name"],"type":"object"},"ApprovedAppInstanceSchema":{"properties":{"app_id":{"format":"uuid","type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","type":"string"}},"required":["app_id","id"],"type":"object"},"AppsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/AppSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"Auth0SettingsSchema":{"properties":{"auth0_client_id":{"type":"string"},"auth0_name":{"type":"string"},"auth0_region":{"type":"string"},"cert_fingerprint":{"type":"string"},"cert_fingerprint_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"digest_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"domain_name":{"readOnly":true,"type":"string"},"idp_x509cert":{"type":"string"},"signature_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#dsa-sha1","http://www.w3.org/2000/09/xmldsig#rsa-sha1","http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","http://www.w3.org/2001/04/xmldsig-more#rsa-sha384","http://www.w3.org/2001/04/xmldsig-more#rsa-sha512"],"type":"string"}},"required":["auth0_client_id","auth0_name","auth0_region"],"type":"object"},"AutoLoginSchema":{"properties":{"app_id":{"type":"string"},"token":{"type":"string"}},"required":["app_id","token"],"type":"object"},"BaseQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":1,"nullable":true,"type":"integer"},"sort":{"description":"A semicolon separated list of `field,order` pairs (name,asc;type,desc).","type":"string"}},"type":"object"},"BillingLimitsSchema":{"properties":{"ai_credits":{"nullable":true,"type":"integer"},"ai_object_detection_hours":{"nullable":true,"type":"integer"},"automation_tasks":{"nullable":true,"type":"integer"},"browse_users":{"nullable":true,"type":"integer"},"edge_transcoders":{"nullable":true,"type":"integer"},"egress_gb":{"nullable":true,"type":"integer"},"face_recognition_hours":{"nullable":true,"type":"integer"},"face_recognition_images":{"nullable":true,"type":"integer"},"image_recognition":{"nullable":true,"type":"integer"},"max_portals":{"nullable":true,"type":"integer"},"max_storage_gateway_clusters":{"nullable":true,"type":"integer"},"max_storage_gateway_nodes":{"nullable":true,"type":"integer"},"multiregion_storage_gb":{"nullable":true,"type":"integer"},"power_users":{"nullable":true,"type":"integer"},"proxy_storage_gb":{"nullable":true,"type":"integer"},"regional_storage_gb":{"nullable":true,"type":"integer"},"shield_enabled":{"nullable":true,"type":"boolean"},"standard_users":{"nullable":true,"type":"integer"},"sync_session_max_clients":{"nullable":true,"type":"integer"},"transcription_hours":{"nullable":true,"type":"integer"}},"type":"object"},"CompleteInvitationSchema":{"properties":{"email_marketing_consent":{"nullable":true,"type":"boolean"},"first_name":{"nullable":true,"type":"string"},"last_name":{"nullable":true,"type":"string"},"password":{"type":"string","writeOnly":true},"repeat_password":{"type":"string","writeOnly":true}},"required":["password","repeat_password"],"type":"object"},"CountriesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/Country"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"Country":{"properties":{"alpha2":{"type":"string"},"alpha3":{"type":"string"},"apolitical_name":{"type":"string"},"name":{"type":"string"},"numeric":{"type":"string"}},"required":["name"],"type":"object"},"CountrySchema":{"properties":{"alpha2":{"type":"string"},"alpha3":{"type":"string"},"apolitical_name":{"type":"string"},"name":{"type":"string"},"numeric":{"type":"string"}},"required":["name"],"type":"object"},"CuttingRoomErrorSchema":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"CuttingRoomTokenResponseSchema":{"properties":{"access_token":{"type":"string"},"expires_in":{"type":"string"},"refresh_expires_in":{"type":"string"},"refresh_token":{"type":"string"},"token_type":{"default":"Bearer","enum":["Bearer"]}},"type":"object"},"DomainIdentityProviderMapSchema":{"properties":{"domain":{"type":"string"},"identity_provider_id":{"format":"uuid","type":"string"},"system_domain_id":{"format":"uuid","type":"string"}},"required":["domain","identity_provider_id","system_domain_id"],"type":"object"},"EmailLoginSchema":{"properties":{"app_name":{"type":"string"},"email":{"format":"email","type":"string"}},"required":["email"],"type":"object"},"EmbedTokenRequestSchema":{"properties":{"app_id":{"format":"uuid","type":"string"},"app_name":{"default":"WEB","type":"string"}},"type":"object"},"EmbedTokenResponseSchema":{"properties":{"app_id":{"type":"string"},"embed_token":{"type":"string"},"expires":{"type":"string"}},"type":"object"},"EnableSystemDomainFeatureSchema":{"properties":{"config":{"oneOf":[{"$ref":"#/components/schemas/PublishFeature"}]}},"required":["config"],"type":"object"},"ExternalAuthRequestResponseSchema":{"properties":{"app_id":{"format":"uuid","type":"string"},"redirect_info":{"$ref":"#/components/schemas/RedirectInfoType"}},"type":"object"},"ExternalAuthRequestSchema":{"properties":{"app_id":{"format":"uuid","type":"string"},"app_name":{"type":"string"},"redirect_info":{"allOf":[{"$ref":"#/components/schemas/RedirectInfoType"}],"nullable":true},"secret":{"type":"string"}},"required":["secret"],"type":"object"},"ExternalAuthSchema":{"properties":{"app_id":{"readOnly":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"redirect_info":{"$ref":"#/components/schemas/RedirectInfoType"},"token":{"readOnly":true,"type":"string"}},"type":"object"},"ForgotPasswordSchema":{"properties":{"email":{"format":"email","type":"string"},"reset_hash":{"nullable":true,"type":"string"}},"required":["email"],"type":"object"},"GenericSettingsSchema":{"properties":{"cert_fingerprint":{"type":"string"},"cert_fingerprint_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"digest_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"domain_name":{"readOnly":true,"type":"string"},"idp_entity_id":{"type":"string"},"idp_sls_redirect_url":{"type":"string"},"idp_sso_post_url":{"type":"string"},"idp_x509cert":{"type":"string"},"name":{"type":"string"},"name_id_encrypted":{"type":"boolean"},"signature_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#dsa-sha1","http://www.w3.org/2000/09/xmldsig#rsa-sha1","http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","http://www.w3.org/2001/04/xmldsig-more#rsa-sha384","http://www.w3.org/2001/04/xmldsig-more#rsa-sha512"],"type":"string"},"want_assertions_signed":{"type":"boolean"},"want_messages_signed":{"type":"boolean"}},"required":["idp_entity_id","idp_sso_post_url","name"],"type":"object"},"IconikTokenResponseSchema":{"properties":{"expires":{"type":"string"},"refresh_token":{"type":"string"},"token":{"type":"string"}},"type":"object"},"IdentityProviderBaseSchema":{"properties":{"saml_settings":{"readOnly":true,"type":"object"}},"type":"object"},"IdentityProviderBaseSettingsSchema":{"properties":{"cert_fingerprint":{"type":"string"},"cert_fingerprint_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"digest_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"domain_name":{"readOnly":true,"type":"string"},"idp_x509cert":{"type":"string"},"signature_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#dsa-sha1","http://www.w3.org/2000/09/xmldsig#rsa-sha1","http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","http://www.w3.org/2001/04/xmldsig-more#rsa-sha384","http://www.w3.org/2001/04/xmldsig-more#rsa-sha512"],"type":"string"}},"type":"object"},"IdentityProviderSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"public_id":{"format":"uuid","readOnly":true,"type":"string"},"saml_settings":{"readOnly":true,"type":"object"},"settings":{"type":"object"},"type":{"enum":["onelogin.com","auth0.com","okta.com","GENERIC"],"type":"string"},"verbose_logging":{"type":"boolean"}},"required":["settings","type"],"type":"object"},"IdentityProvidersSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/IdentityProviderSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"InternalAuthenticateUserSchema":{"properties":{"app_name":{"type":"string"},"marketplace_signup_nonce":{"type":"string"},"user":{"type":"object"}},"required":["app_name","user"],"type":"object"},"InternalTempTokenSchema":{"properties":{"email":{"format":"email","type":"string"},"expires_in":{"type":"integer"}},"required":["email","expires_in"],"type":"object"},"InvitationResponseSchema":{"properties":{"auto_login":{"type":"boolean"},"domain_status":{"enum":["ACTIVE","WARNING","FROZEN","DEACTIVATED"],"type":"string"},"login_data":{"$ref":"#/components/schemas/AutoLoginSchema"},"user_id":{"format":"uuid","readOnly":true,"type":"string"}},"type":"object"},"ListObjectsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"MarketplaceGoogleLinkSchema":{"properties":{"marketplace_signup_nonce":{"type":"string"}},"required":["marketplace_signup_nonce"],"type":"object"},"MarketplaceGoogleSignupSchema":{"properties":{"x-gcp-marketplace-token":{"type":"string"}},"type":"object"},"MultiDomainLoginSchema":{"properties":{"app_name":{"type":"string"},"email":{"format":"email","type":"string"},"marketplace_signup_nonce":{"type":"string"},"otp":{"nullable":true,"type":"string"},"otp_type":{"nullable":true,"type":"string"},"system_domain_id":{"format":"uuid","type":"string"}},"required":["email","system_domain_id"],"type":"object"},"MultiDomainUserSystemSchema":{"properties":{"logo_url":{"format":"url","readOnly":true,"type":"string"},"mfa_methods":{"items":{"enum":["TOTP","MAIL_2SV"],"readOnly":true,"type":"string"},"type":"array"},"mfa_methods_configured":{"items":{"enum":["TOTP","MAIL_2SV"],"readOnly":true,"type":"string"},"type":"array"},"mfa_required":{"readOnly":true,"type":"boolean"},"mfa_required_configured":{"readOnly":true,"type":"boolean"},"platform_url":{"format":"url","readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"system_domain_name":{"readOnly":true,"type":"string"},"url":{"format":"url","readOnly":true,"type":"string"}},"required":["system_domain_id"],"type":"object"},"MultiDomainUserSystemsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/MultiDomainUserSystemSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"MultiPlatformDomainUserSystemSchema":{"properties":{"logo_url":{"format":"url","readOnly":true,"type":"string"},"mfa_methods":{"items":{"enum":["TOTP","MAIL_2SV"],"readOnly":true,"type":"string"},"type":"array"},"mfa_methods_configured":{"items":{"enum":["TOTP","MAIL_2SV"],"readOnly":true,"type":"string"},"type":"array"},"mfa_required":{"readOnly":true,"type":"boolean"},"mfa_required_configured":{"readOnly":true,"type":"boolean"},"platform_url":{"format":"url","readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","type":"string"},"system_domain_name":{"readOnly":true,"type":"string"},"token":{"type":"string"},"url":{"format":"url","readOnly":true,"type":"string"}},"required":["system_domain_id","token"],"type":"object"},"NotifyOTPConfigurationChangedSchema":{"properties":{"email":{"format":"email","type":"string"},"message_type":{"enum":["otp_enabled","otp_disabled","totp_enabled","totp_disabled"],"type":"string"},"metadata":{"nullable":true,"type":"object"}},"required":["email","message_type"],"type":"object"},"NotifySystemDomainOTPConfigurationChangedSchema":{"properties":{"message_type":{"enum":["otp_enabled","otp_disabled","totp_enabled","totp_disabled"],"type":"string"},"metadata":{"nullable":true,"type":"object"},"user_id":{"type":"string"}},"required":["message_type","user_id"],"type":"object"},"OAuth2AuthorizeClientSchema":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"OAuth2AuthorizeDescribeSchema":{"properties":{"client":{"$ref":"#/components/schemas/OAuth2AuthorizeClientSchema"},"redirect_uri":{"type":"string"},"scopes":{"items":{"type":"string"},"type":"array"},"state":{"nullable":true,"type":"string"},"system_domain":{"$ref":"#/components/schemas/OAuth2AuthorizeSystemDomain"},"user":{"$ref":"#/components/schemas/OAuth2AuthorizeUser"}},"required":["client","redirect_uri","scopes","system_domain","user"],"type":"object"},"OAuth2AuthorizeResponseSchema":{"properties":{"redirect_uri":{"type":"string"}},"required":["redirect_uri"],"type":"object"},"OAuth2AuthorizeSystemDomain":{"properties":{"id":{"format":"uuid","type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"OAuth2AuthorizeSystemDomainSchema":{"properties":{"id":{"format":"uuid","type":"string"},"name":{"type":"string"}},"required":["id","name"],"type":"object"},"OAuth2AuthorizeUser":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"nullable":true,"type":"string"},"id":{"format":"uuid","type":"string"},"last_name":{"nullable":true,"type":"string"},"photo":{"nullable":true,"type":"string"}},"required":["email","id"],"type":"object"},"OAuth2AuthorizeUserSchema":{"properties":{"email":{"format":"email","type":"string"},"first_name":{"nullable":true,"type":"string"},"id":{"format":"uuid","type":"string"},"last_name":{"nullable":true,"type":"string"},"photo":{"nullable":true,"type":"string"}},"required":["email","id"],"type":"object"},"OAuthScopesSchema":{"properties":{"scopes":{"items":{"type":"string"},"readOnly":true,"type":"array"}},"type":"object"},"OktaSettingsSchema":{"properties":{"cert_fingerprint":{"type":"string"},"cert_fingerprint_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"digest_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"domain_name":{"readOnly":true,"type":"string"},"idp_x509cert":{"type":"string"},"okta_app_id":{"type":"string"},"okta_name":{"type":"string"},"okta_preview":{"type":"boolean"},"okta_sso":{"type":"string"},"signature_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#dsa-sha1","http://www.w3.org/2000/09/xmldsig#rsa-sha1","http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","http://www.w3.org/2001/04/xmldsig-more#rsa-sha384","http://www.w3.org/2001/04/xmldsig-more#rsa-sha512"],"type":"string"}},"required":["okta_name"],"type":"object"},"OneloginSettingsSchema":{"properties":{"cert_fingerprint":{"type":"string"},"cert_fingerprint_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"digest_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#sha1","http://www.w3.org/2001/04/xmlenc#sha256","http://www.w3.org/2001/04/xmldsig-more#sha384","http://www.w3.org/2001/04/xmlenc#sha512"],"type":"string"},"domain_name":{"readOnly":true,"type":"string"},"idp_x509cert":{"type":"string"},"onelogin_client_id":{"type":"string"},"onelogin_name":{"type":"string"},"signature_algorithm":{"enum":["http://www.w3.org/2000/09/xmldsig#dsa-sha1","http://www.w3.org/2000/09/xmldsig#rsa-sha1","http://www.w3.org/2001/04/xmldsig-more#rsa-sha256","http://www.w3.org/2001/04/xmldsig-more#rsa-sha384","http://www.w3.org/2001/04/xmldsig-more#rsa-sha512"],"type":"string"}},"required":["onelogin_client_id","onelogin_name"],"type":"object"},"PasswordChecksSchema":{"properties":{"digits":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"lowercase":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"max_length":{"format":"int32","maximum":64,"minimum":8,"nullable":true,"type":"integer"},"min_length":{"format":"int32","maximum":56,"minimum":8,"nullable":true,"type":"integer"},"special_symbols":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"uppercase":{"format":"int32","minimum":0,"nullable":true,"type":"integer"}},"type":"object"},"PublishFeature":{"properties":{"feature":{"default":"WM_PUBLISH_PANEL","enum":["WM_PUBLISH_PANEL"]},"parameters":{"$ref":"#/components/schemas/PublishFeatureParameters"}},"required":["feature","parameters"],"type":"object"},"PublishFeatureParameters":{"properties":{"region":{"description":"Wildmoka region, must be explicitly set to US or EU","enum":["US","EU"],"example":"","type":"string"},"salesforce_id":{"type":"string"}},"required":["region","salesforce_id"],"type":"object"},"PublishFeatureSchema":{"properties":{"feature":{"default":"WM_PUBLISH_PANEL","enum":["WM_PUBLISH_PANEL"]},"parameters":{"$ref":"#/components/schemas/PublishFeatureParameters"}},"required":["feature","parameters"],"type":"object"},"RedirectInfoType":{"properties":{"headers":{"nullable":true,"type":"object"},"url":{"format":"url","nullable":true,"type":"string"}},"type":"object"},"RedirectInfoTypeSchema":{"properties":{"headers":{"nullable":true,"type":"object"},"url":{"format":"url","nullable":true,"type":"string"}},"type":"object"},"ReferralCodeSchema":{"properties":{"billing_tier":{"enum":["PAYGO","PRO","ENTERPRISE","ENTERPRISE_LEGACY_2025","PRO_LEGACY_2025"],"nullable":true,"type":"string"},"code":{"type":"string"},"credit_expiry_days":{"nullable":true,"type":"integer"},"do_not_delete":{"nullable":true,"type":"boolean"},"freeze_date":{"format":"date-time","nullable":true,"type":"string"},"is_plg":{"nullable":true,"type":"boolean"},"manage_system_domain_id":{"format":"uuid","nullable":true,"type":"string"},"ordway_customer_id":{"nullable":true,"type":"string"},"sales_force_id":{"nullable":true,"type":"string"},"valid_to":{"format":"date-time","type":"string"},"value":{"type":"number"}},"required":["code","valid_to","value"],"type":"object"},"ReferralCodesSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/ReferralCodeSchema"},"readOnly":true,"type":"array"}},"type":"object"},"RegistrationSchema":{"properties":{"base_url":{"readOnly":true,"type":"string"},"company_name":{"nullable":true,"type":"string"},"country":{"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"email":{"format":"email","type":"string"},"email_marketing_consent":{"nullable":true,"type":"boolean"},"first_name":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"last_name":{"type":"string"},"marketplace_signup_nonce":{"type":"string"},"ordway_customer_id":{"type":"string"},"ordway_subscription_id":{"type":"string"},"password":{"type":"string","writeOnly":true},"referral_code":{"type":"string"},"stripe_id":{"type":"string"}},"required":["country","email","first_name","last_name","password"],"type":"object"},"ReindexSystemDomainSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ResetPasswordSchema":{"properties":{"password":{"type":"string","writeOnly":true},"repeat_password":{"type":"string","writeOnly":true}},"required":["password","repeat_password"],"type":"object"},"SAMLLoginSchema":{"properties":{"email":{"format":"email","type":"string"}},"required":["email"],"type":"object"},"SimpleLoginSchema":{"properties":{"app_name":{"type":"string"},"email":{"format":"email","type":"string"},"marketplace_signup_nonce":{"type":"string"},"password":{"type":"string","writeOnly":true}},"required":["email","password"],"type":"object"},"SystemDomainBaseSchema":{"properties":{},"type":"object"},"SystemDomainBasicAdminSchema":{"properties":{"billing_tier":{"enum":["PAYGO","PRO","ENTERPRISE","ENTERPRISE_LEGACY_2025","PRO_LEGACY_2025"],"readOnly":true,"type":"string"},"contract_end_date":{"format":"date-time","readOnly":true,"type":"string"},"country":{"readOnly":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"features":{"items":{"type":"string"},"readOnly":true,"type":"array"},"freeze_date":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_plg":{"type":"boolean"},"name":{"type":"string"},"type":{"enum":["TRIAL","CUSTOMER","PARTNER","INTERNAL"],"readOnly":true,"type":"string"}},"required":["name"],"type":"object"},"SystemDomainBasicSchema":{"properties":{"billing_tier":{"enum":["PAYGO","PRO","ENTERPRISE","ENTERPRISE_LEGACY_2025","PRO_LEGACY_2025"],"readOnly":true,"type":"string"},"country":{"readOnly":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"features":{"items":{"type":"string"},"readOnly":true,"type":"array"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_plg":{"type":"boolean"},"name":{"type":"string"},"type":{"enum":["TRIAL","CUSTOMER","PARTNER","INTERNAL"],"readOnly":true,"type":"string"}},"required":["name"],"type":"object"},"SystemDomainFromReferralCodeSchema":{"properties":{"admin_email":{"type":"string"},"admin_first_name":{"type":"string"},"admin_last_name":{"type":"string"},"admin_password":{"type":"string"},"billing_tier":{"enum":["PAYGO","PRO","ENTERPRISE","ENTERPRISE_LEGACY_2025","PRO_LEGACY_2025"],"type":"string"},"country_code":{"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"}},"required":["country_code","name"],"type":"object"},"SystemDomainFromTemplateSchema":{"properties":{"admin_email":{"type":"string"},"admin_first_name":{"type":"string"},"admin_id":{"format":"uuid","readOnly":true,"type":"string"},"admin_last_name":{"type":"string"},"admin_password":{"type":"string"},"base_url":{"type":"string"},"billing_tier":{"enum":["PAYGO","PRO","ENTERPRISE","ENTERPRISE_LEGACY_2025","PRO_LEGACY_2025"],"type":"string"},"custom_terms":{"type":"boolean"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"status":{"enum":["ACTIVE","WARNING","FROZEN","DEACTIVATED"],"type":"string"},"type":{"enum":["TRIAL","CUSTOMER","PARTNER","INTERNAL"],"type":"string"}},"required":["name"],"type":"object"},"SystemDomainProfileSchema":{"properties":{"industry":{"enum":["ADVERTISING_MARKETING_CREATIVE","AUTOMOTIVE","BROADCASTER_NETWORKS","CONSTRUCTION_MANUFACTURING","EDUCATION","ENERGY_UTILITIES","FAITH_RELIGIOUS_ORGS","FINANCE","GAME_STUDIOS_PUBLISHERS","GOVERNMENT_PUBLIC_SECTOR","HEALTHCARE","HOSPITALITY_FITNESS_WELLNESS","LIVE_PRODUCTION_EVENTS","MEDIA_CONGLOMERATES","NONPROFITS_NON_RELIGIOUS","ONLINE_MEDIA","PUBLISHERS_NEWSPAPERS","TELECOMMUNICATIONS","RETAIL_CONSUMER_GOODS","SOFTWARE_TECHNOLOGY","SPORTS_RIGHTS_LEAGUES","STUDIOS_CONTENT_PRODUCERS","OTHER"],"type":"string"}},"type":"object"},"SystemDomainSchema":{"properties":{"base_url":{"type":"string"},"billing_limits":{"allOf":[{"$ref":"#/components/schemas/BillingLimitsSchema"}],"nullable":true},"billing_tier":{"enum":["PAYGO","PRO","ENTERPRISE","ENTERPRISE_LEGACY_2025","PRO_LEGACY_2025"],"type":"string"},"contract_end_date":{"format":"date-time","readOnly":true,"type":"string"},"country":{"readOnly":true,"type":"string"},"creating_user_id":{"format":"uuid","readOnly":true,"type":"string"},"custom_terms":{"readOnly":true,"type":"boolean"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"deactivate_date":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"disable_ai_features":{"readOnly":true,"type":"boolean"},"disable_billing_page":{"readOnly":true,"type":"boolean"},"disable_cc_purchase":{"type":"boolean"},"discount_percent":{"readOnly":true,"type":"number"},"do_not_charge_edge_transcoder":{"readOnly":true,"type":"boolean"},"do_not_charge_remote_proxies":{"readOnly":true,"type":"boolean"},"do_not_charge_shield":{"readOnly":true,"type":"boolean"},"do_not_trace_ai_usage":{"readOnly":true,"type":"boolean"},"features":{"items":{"type":"string"},"readOnly":true,"type":"array"},"freeze_date":{"format":"date-time","readOnly":true,"type":"string"},"has_preloaded_assets":{"type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"industry":{"enum":["ADVERTISING_MARKETING_CREATIVE","AUTOMOTIVE","BROADCASTER_NETWORKS","CONSTRUCTION_MANUFACTURING","EDUCATION","ENERGY_UTILITIES","FAITH_RELIGIOUS_ORGS","FINANCE","GAME_STUDIOS_PUBLISHERS","GOVERNMENT_PUBLIC_SECTOR","HEALTHCARE","HOSPITALITY_FITNESS_WELLNESS","LIVE_PRODUCTION_EVENTS","MEDIA_CONGLOMERATES","NONPROFITS_NON_RELIGIOUS","ONLINE_MEDIA","PUBLISHERS_NEWSPAPERS","TELECOMMUNICATIONS","RETAIL_CONSUMER_GOODS","SOFTWARE_TECHNOLOGY","SPORTS_RIGHTS_LEAGUES","STUDIOS_CONTENT_PRODUCERS","OTHER"],"type":"string"},"invoice_end_of_month":{"readOnly":true,"type":"boolean"},"is_plg":{"type":"boolean"},"is_template":{"readOnly":true,"type":"boolean"},"licensed_user_billing":{"readOnly":true,"type":"boolean"},"marketplace_customer_id":{"readOnly":true,"type":"string"},"marketplace_entitlement_id":{"readOnly":true,"type":"string"},"name":{"type":"string"},"ordway_customer_id":{"readOnly":true,"type":"string"},"ordway_subscription_id":{"readOnly":true,"type":"string"},"platform_name":{"readOnly":true,"type":"string"},"price_list":{"readOnly":true,"type":"string"},"primary_region":{"readOnly":true,"type":"string"},"referral_code":{"readOnly":true,"type":"string"},"sales_force_id":{"readOnly":true,"type":"string"},"status":{"enum":["ACTIVE","WARNING","FROZEN","DEACTIVATED"],"readOnly":true,"type":"string"},"stripe_id":{"readOnly":true,"type":"string"},"type":{"enum":["TRIAL","CUSTOMER","PARTNER","INTERNAL"],"readOnly":true,"type":"string"},"warning_message":{"readOnly":true,"type":"string"}},"required":["base_url","name"],"type":"object"},"SystemDomainSuperAdminSchema":{"properties":{"base_url":{"type":"string"},"billing_limits":{"allOf":[{"$ref":"#/components/schemas/BillingLimitsSchema"}],"nullable":true},"billing_tier":{"enum":["PAYGO","PRO","ENTERPRISE","ENTERPRISE_LEGACY_2025","PRO_LEGACY_2025"],"type":"string"},"contract_end_date":{"format":"date-time","nullable":true,"type":"string"},"country":{"nullable":true,"type":"string"},"creating_user_id":{"format":"uuid","nullable":true,"type":"string"},"custom_terms":{"type":"boolean"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"deactivate_date":{"format":"date-time","nullable":true,"type":"string"},"description":{"type":"string"},"disable_ai_features":{"type":"boolean"},"disable_billing_page":{"type":"boolean"},"disable_cc_purchase":{"type":"boolean"},"discount_percent":{"nullable":true,"type":"number"},"do_not_charge_edge_transcoder":{"type":"boolean"},"do_not_charge_remote_proxies":{"type":"boolean"},"do_not_charge_shield":{"type":"boolean"},"do_not_trace_ai_usage":{"type":"boolean"},"features":{"items":{"type":"string"},"type":"array"},"freeze_date":{"format":"date-time","nullable":true,"type":"string"},"has_preloaded_assets":{"type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"industry":{"enum":["ADVERTISING_MARKETING_CREATIVE","AUTOMOTIVE","BROADCASTER_NETWORKS","CONSTRUCTION_MANUFACTURING","EDUCATION","ENERGY_UTILITIES","FAITH_RELIGIOUS_ORGS","FINANCE","GAME_STUDIOS_PUBLISHERS","GOVERNMENT_PUBLIC_SECTOR","HEALTHCARE","HOSPITALITY_FITNESS_WELLNESS","LIVE_PRODUCTION_EVENTS","MEDIA_CONGLOMERATES","NONPROFITS_NON_RELIGIOUS","ONLINE_MEDIA","PUBLISHERS_NEWSPAPERS","TELECOMMUNICATIONS","RETAIL_CONSUMER_GOODS","SOFTWARE_TECHNOLOGY","SPORTS_RIGHTS_LEAGUES","STUDIOS_CONTENT_PRODUCERS","OTHER"],"type":"string"},"invoice_end_of_month":{"type":"boolean"},"is_plg":{"type":"boolean"},"is_template":{"type":"boolean"},"licensed_user_billing":{"type":"boolean"},"marketplace_customer_id":{"nullable":true,"type":"string"},"marketplace_entitlement_id":{"nullable":true,"type":"string"},"name":{"type":"string"},"ordway_customer_id":{"nullable":true,"type":"string"},"ordway_subscription_id":{"nullable":true,"type":"string"},"platform_name":{"readOnly":true,"type":"string"},"price_list":{"nullable":true,"type":"string"},"referral_code":{"nullable":true,"type":"string"},"sales_force_id":{"nullable":true,"type":"string"},"status":{"enum":["ACTIVE","WARNING","FROZEN","DEACTIVATED"],"type":"string"},"stripe_id":{"nullable":true,"type":"string"},"type":{"enum":["TRIAL","CUSTOMER","PARTNER","INTERNAL"],"type":"string"},"warning_message":{"type":"string"}},"required":["base_url","name"],"type":"object"},"SystemDomainWildmokaConfigSchema":{"properties":{"api_base_url":{"description":"Wildmoka API endpoint URL","nullable":true,"type":"string"},"issuer":{"description":"JWT issuer to use for authentication","nullable":true,"type":"string"},"role_arn":{"description":"AWS IAM role ARN for Wildmoka S3 access","nullable":true,"type":"string"},"secret_key":{"description":"JWT secret key to use for authentication","nullable":true,"type":"string"},"ui_base_url":{"description":"Wildmoka UI endpoint URL","nullable":true,"type":"string"}},"type":"object"},"SystemDomainWithBillingLimitsSchema":{"properties":{},"type":"object"},"SystemDomainsQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":1,"nullable":true,"type":"integer"},"sort":{"description":"A semicolon separated list of `field,order` pairs (name,asc;type,desc).","type":"string"}},"type":"object"},"SystemDomainsSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/SystemDomainSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"TemporaryPasswordTokenSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"email":{"format":"email","type":"string"},"expires":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"token":{"type":"string"}},"required":["email","token"],"type":"object"},"TokenBaseSchema":{"properties":{"app_id":{"format":"uuid","readOnly":true,"type":"string"},"auth_system_domains":{"items":{"$ref":"#/components/schemas/MultiDomainUserSystemSchema"},"readOnly":true,"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"expires":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_admin":{"readOnly":true,"type":"boolean"},"is_mfa_authenticated":{"readOnly":true,"type":"boolean"},"is_saml_authenticated":{"readOnly":true,"type":"boolean"},"is_super_admin":{"readOnly":true,"type":"boolean"},"is_super_admin_light":{"readOnly":true,"type":"boolean"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_is_plg":{"readOnly":true,"type":"boolean"},"system_domain_status":{"enum":["ACTIVE","WARNING","FROZEN","DEACTIVATED"],"readOnly":true,"type":"string"},"system_domain_type":{"readOnly":true,"type":"string"},"system_domain_warning_message":{"readOnly":true,"type":"string"},"system_domains":{"items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"user_id":{"format":"uuid","readOnly":true,"type":"string"}},"type":"object"},"TokenExchangeRequestSchema":{"properties":{"embed_token":{"type":"string"},"requested_scopes":{"items":{"type":"string"},"type":"array"}},"required":["embed_token"],"type":"object"},"TokenMultiplatformLoginSchema":{"properties":{"app_id":{"format":"uuid","readOnly":true,"type":"string"},"auth_system_domains":{"items":{"$ref":"#/components/schemas/MultiPlatformDomainUserSystemSchema"},"readOnly":true,"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"expires":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_admin":{"readOnly":true,"type":"boolean"},"is_mfa_authenticated":{"readOnly":true,"type":"boolean"},"is_saml_authenticated":{"readOnly":true,"type":"boolean"},"is_super_admin":{"readOnly":true,"type":"boolean"},"is_super_admin_light":{"readOnly":true,"type":"boolean"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_is_plg":{"readOnly":true,"type":"boolean"},"system_domain_status":{"enum":["ACTIVE","WARNING","FROZEN","DEACTIVATED"],"readOnly":true,"type":"string"},"system_domain_type":{"readOnly":true,"type":"string"},"system_domain_warning_message":{"readOnly":true,"type":"string"},"system_domains":{"items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"token":{"description":"Deprecated field. Use the token field from the `auth_system_domains` items instead.","nullable":true,"type":"string"},"user_id":{"format":"uuid","readOnly":true,"type":"string"}},"type":"object"},"TokenOutputSchema":{"properties":{"app_id":{"format":"uuid","readOnly":true,"type":"string"},"auth_system_domains":{"items":{"$ref":"#/components/schemas/MultiDomainUserSystemSchema"},"readOnly":true,"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"expires":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_admin":{"readOnly":true,"type":"boolean"},"is_mfa_authenticated":{"readOnly":true,"type":"boolean"},"is_saml_authenticated":{"readOnly":true,"type":"boolean"},"is_super_admin":{"readOnly":true,"type":"boolean"},"is_super_admin_light":{"readOnly":true,"type":"boolean"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_is_plg":{"readOnly":true,"type":"boolean"},"system_domain_status":{"enum":["ACTIVE","WARNING","FROZEN","DEACTIVATED"],"readOnly":true,"type":"string"},"system_domain_type":{"readOnly":true,"type":"string"},"system_domain_warning_message":{"readOnly":true,"type":"string"},"system_domains":{"items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"user_id":{"format":"uuid","readOnly":true,"type":"string"}},"type":"object"},"TokenSchema":{"properties":{"app_id":{"format":"uuid","readOnly":true,"type":"string"},"auth_system_domains":{"items":{"$ref":"#/components/schemas/MultiDomainUserSystemSchema"},"readOnly":true,"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"expires":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_admin":{"readOnly":true,"type":"boolean"},"is_mfa_authenticated":{"readOnly":true,"type":"boolean"},"is_saml_authenticated":{"readOnly":true,"type":"boolean"},"is_super_admin":{"readOnly":true,"type":"boolean"},"is_super_admin_light":{"readOnly":true,"type":"boolean"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"system_domain_is_plg":{"readOnly":true,"type":"boolean"},"system_domain_status":{"enum":["ACTIVE","WARNING","FROZEN","DEACTIVATED"],"readOnly":true,"type":"string"},"system_domain_type":{"readOnly":true,"type":"string"},"system_domain_warning_message":{"readOnly":true,"type":"string"},"system_domains":{"items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"token":{"type":"string"},"user_id":{"format":"uuid","readOnly":true,"type":"string"}},"required":["token"],"type":"object"},"TokensSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/TokenOutputSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"UserSystemDomainInviteSchema":{"properties":{"id":{"format":"uuid","type":"string"},"is_existing_user_invitation":{"default":false,"type":"boolean"},"is_initial_user_invitation":{"default":false,"type":"boolean"},"system_domain_id":{"format":"uuid","type":"string"}},"required":["id","system_domain_id"],"type":"object"},"VerificationResponseSchema":{"properties":{"auto_login":{"type":"boolean"},"domain_data":{"$ref":"#/components/schemas/SystemDomainFromTemplateSchema"},"login_data":{"$ref":"#/components/schemas/AutoLoginSchema"}},"type":"object"},"VerifyInviteByLinkSchema":{"properties":{"inviter_email":{"format":"email","type":"string"},"local_user_exists":{"type":"boolean"},"new_user_email":{"format":"email","type":"string"},"new_user_first_name":{"type":"string"},"system_domain_id":{"format":"uuid","type":"string"}},"required":["inviter_email","local_user_exists","new_user_email","new_user_first_name","system_domain_id"],"type":"object"},"WebflowContentSchema":{"properties":{"caption":{"type":"string"},"category":{"type":"string"},"image":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["slug"],"type":"object"},"_SystemDomainFeatureSchemaBase":{"properties":{"parameters":{"type":"object"}},"type":"object"}}},"info":{"title":"Iconik Auth","version":"2.0.0"},"openapi":"3.0.3","paths":{"/":{},"/ip/":{},"/livez/":{},"/readyz/":{},"/spec/":{},"/static/{filename}":{},"/v1/apps/":{"get":{"description":"\nRequired roles:\n - can_read_apps\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"format":"int32","type":"integer"},"style":"form"},{"description":"ID of a last file set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppsSchema"}}},"description":"Returns a list of app"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List of apps"},"post":{"description":"\nRequired roles:\n - can_write_apps\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppCreateSchema"}}},"description":"Returns a created app"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new app"}},"/v1/apps/allowed_origins/all/":{},"/v1/apps/external/auth/":{"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAuthRequestSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAuthRequestResponseSchema"}}},"description":"Returns an app_id"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new token for the logged in user and store it for an external app"}},"/v1/apps/external/auth/{secret}/":{"get":{"description":"","parameters":[{"in":"path","name":"secret","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAuthSchema"}}},"description":"Returns auth info"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Gets a token requested by an external app"}},"/v1/apps/instance/":{"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovedAppInstanceSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovedAppInstanceSchema"}}},"description":"Returns a created app"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new app instance"}},"/v1/apps/instance/{approved_instance_id}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"approved_instance_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete an approved instance of an app"},"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"approved_instance_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalAuthSchema"}}},"description":"Returns auth info"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Gets an approved instance of an app"}},"/v1/apps/oauth_scopes/":{"get":{"description":"\nRequired roles:\n - can_read_apps\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthScopesSchema"}}},"description":"Returns the list of OAuth scopes an app's allowed_scopes may contain"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List of OAuth scopes currently supported by the platform"}},"/v1/apps/{app_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_apps\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"app_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular app by id"},"get":{"description":"\nRequired roles:\n - can_read_apps\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"app_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppSchema"}}},"description":"Returns a app"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular app by id"},"patch":{"description":"\nRequired roles:\n - can_write_apps\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"app_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppSchema"}}},"description":"Returns an updated app"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update app"},"put":{"description":"\nRequired roles:\n - can_write_apps\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"app_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppSchema"}}},"description":"Returns an updated app"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update app"}},"/v1/apps/{app_id}/current_user_token/":{},"/v1/apps/{app_id}/token/":{"post":{"description":"\nRequired roles:\n - can_read_apps\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"app_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of seconds the token will be valid for. Defaults to the system default.","in":"query","name":"expires_in","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenSchema"}}},"description":"Returns an application token"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Creates app token by id and returns it's data"}},"/v1/auth/ad/login/":{"post":{"description":"<br/>This function is not yet implemented.","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenSchema"}}},"description":"Returns a new generated token for particular user"},"400":{"description":"Bad request"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Login by ActiveDirectory"}},"/v1/auth/current/otp/generate/":{"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Request OTP code as an authenticated user"}},"/v1/auth/embed/token/":{"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedTokenRequestSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbedTokenResponseSchema"}}},"description":"Returns an embed token"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a short lived, single use embed token for the logged in user"}},"/v1/auth/embed/token/exchange/":{"post":{"description":"","parameters":[{"description":"Output format, one of `cuttingroom` (default) or `iconik`","in":"query","name":"format","required":false,"schema":{"type":"string"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenExchangeRequestSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CuttingRoomTokenResponseSchema"}}},"description":"Returns an access token and a refresh token"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Exchange an embed token for an iconik access token"}},"/v1/auth/multidomain/login/":{"post":{"description":"","parameters":[{"in":"header","name":"Temp-Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDomainLoginSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenSchema"}}},"description":"Returns a new generated token for particular user"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Login by using temp token"}},"/v1/auth/otp/generate/":{"post":{"description":"","parameters":[{"in":"header","name":"Temp-Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDomainLoginSchema"}}},"description":"body","required":true},"responses":{"201":{"description":"Success"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Request OTP code"}},"/v1/auth/saml/acs/{public_id}/":{"post":{"description":"","parameters":[{"in":"path","name":"public_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"302":{"description":"Redirect on SAML IDP for SSO"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized request"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Assertion Consumer Service"}},"/v1/auth/saml/acs/{system_domain_id}/{identity_provider_id}/":{"post":{"deprecated":true,"description":"","parameters":[{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"identity_provider_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"302":{"description":"Redirect on SAML IDP for SSO"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized request"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Assertion Consumer Service"}},"/v1/auth/saml/domains/":{"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainIdentityProviderMapSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainIdentityProviderMapSchema"}}},"description":"Returns an identity provider"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Bind domain to identity provider"}},"/v1/auth/saml/domains/{domain}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"domain","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"No body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Unbind domain from identity provider"}},"/v1/auth/saml/idp/":{"get":{"description":"\nRequired roles:\n - can_read_identity_providers\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProvidersSchema"}}},"description":"Returns a list of identity providers"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get list of identity providers"},"post":{"description":"<br/>Input can either be an IdentityProviderSchema as json or a SAML<br/>EntityDescriptor XML.<br/>Input can either be an IdentityProviderSchema as json or a SAML<br/>EntityDescriptor XML.\nRequired roles:\n - can_write_identity_providers\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}},"application/xml":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}}},"description":"Returns an identity provider"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new identity provider."}},"/v1/auth/saml/idp/convert/":{"post":{"description":"<br/>Input should be a SAML EntityDescriptor XML.","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}}},"description":"Returns an identity provider"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Convert an IdP EntityDescriptor XML into json suitable as a settings configuration."}},"/v1/auth/saml/idp/{identity_provider_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_identity_providers\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"identity_provider_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"No body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Identity provider does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular identity provider by id"},"get":{"description":"\nRequired roles:\n - can_read_identity_providers\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"identity_provider_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}}},"description":"Returns an identity provider"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Identity provider does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a particular identity provider by id"},"patch":{"description":"\nRequired roles:\n - can_write_identity_providers\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"identity_provider_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}}},"description":"Returns an updated identity provider"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Identity provider does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a particular identity provider by id"},"put":{"description":"\nRequired roles:\n - can_write_identity_providers\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"identity_provider_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityProviderSchema"}}},"description":"Returns an updated identity provider"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Identity provider does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a particular identity provider by id"}},"/v1/auth/saml/login/":{"post":{"deprecated":true,"description":"","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLLoginSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"url":{"description":"saml sso url","type":"string"}},"type":"object"}}},"description":"Returns an saml sso url"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Single sign-on url by domain"}},"/v1/auth/saml/logout/{public_id}/":{"post":{"description":"","parameters":[{"in":"path","name":"public_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"url":{"description":"saml sso url. No url is returned if Single Logout is unsupported by IdP","type":"string"}},"type":"object"}}},"description":"Returns an saml slo url"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Initiate SAML Single logout"}},"/v1/auth/saml/metadata/{public_id}/":{"get":{"description":"","parameters":[{"in":"path","name":"public_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Return SAML SP metadata"},"400":{"description":"Bad request"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Single Logout Service"}},"/v1/auth/saml/metadata/{system_domain_id}/{identity_provider_id}/":{"get":{"deprecated":true,"description":"","parameters":[{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"identity_provider_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Return SAML SP metadata"},"400":{"description":"Bad request"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Single Logout Service"}},"/v1/auth/saml/multidomain/login/":{"post":{"description":"","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SAMLLoginSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiDomainUserSystemsSchema"}}},"description":"Returns list of SSO domains"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Single sign-on url by domain"}},"/v1/auth/saml/slo/{public_id}/":{"get":{"description":"","parameters":[{"in":"path","name":"public_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"302":{"description":"Redirect on SAML IDP for SLO"},"400":{"description":"Bad request"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Single Logout Service"}},"/v1/auth/saml/slo/{system_domain_id}/{identity_provider_id}/":{"get":{"deprecated":true,"description":"","parameters":[{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"identity_provider_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"302":{"description":"Redirect on SAML IDP for SLO"},"400":{"description":"Bad request"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Single Logout Service"}},"/v1/auth/saml/sso/{public_id}/":{"get":{"description":"","parameters":[{"in":"path","name":"public_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"302":{"description":"Redirect on SAML IDP for SSO"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Single sign-on Service"}},"/v1/auth/saml/sso/{system_domain_id}/{identity_provider_id}/":{"get":{"deprecated":true,"description":"","parameters":[{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"identity_provider_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"302":{"description":"Redirect on SAML IDP for SSO"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"SAML Single sign-on Service"}},"/v1/auth/simple/login/":{"post":{"description":"","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleLoginSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenMultiplatformLoginSchema"}}},"description":"Returns a new generated token for particular user"},"400":{"description":"Bad request"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Login by using email and password"}},"/v1/auth/token/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Returns if token was revoked"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Revoke token"},"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Returns if token valid"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Check if auth token valid"},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of seconds the token will be valid for. Defaults to the system default.","in":"query","name":"expires_in","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenSchema"}}},"description":"Returns a new token"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create new token without invalidating the old one"},"put":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenSchema"}}},"description":"Returns a new token"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Refresh token"}},"/v1/auth/token/{token_id}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"token_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Returns if token was revoked"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Revoke token by ID"},"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"token_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Returns a token"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get token by ID"}},"/v1/auth/tokens/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"format":"int32","type":"integer"},"style":"form"},{"description":"ID of a last file set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokensSchema"}}},"description":"Returns a list of tokens"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List of tokens"}},"/v1/auth/{app_id}/tokens/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"format":"int32","type":"integer"},"style":"form"},{"in":"path","name":"app_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"ID of a last file set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokensSchema"}}},"description":"Returns a list of tokens"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List application tokens"}},"/v1/invitation/complete/{reset_hash}/":{"put":{"description":"","parameters":[{"in":"path","name":"reset_hash","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteInvitationSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvitationResponseSchema"}}},"description":"User completed invite process"},"400":{"description":"Bad request"},"419":{"description":"Authentication token expired"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Completes invitation by setting password and other user details"}},"/v1/invite_link/emails/":{},"/v1/marketplace/google/link/":{"post":{"description":"","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplaceGoogleLinkSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Successfully linked google account to existing system domain"},"400":{"description":"Bad request"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Google cloud marketplace link to existing system domain"}},"/v1/marketplace/google/signup/":{"post":{"description":"","parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/MarketplaceGoogleSignupSchema"}}},"description":"A request multipart/form-data"},"responses":{"302":{"description":"Redirects to the registration page"},"400":{"description":"Bad request"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Google cloud marketplace signup"}},"/v1/oauth/authorize/":{"get":{"description":"(client name, authorizing user, system domain, scopes, redirect_uri,<br/>state). No code is minted.","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The OAuth2 application client ID","in":"query","name":"client_id","required":true,"schema":{"type":"string"},"style":"form"},{"description":"The URI to redirect to after authorization. Must exactly match one of the URIs registered for the application.","in":"query","name":"redirect_uri","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Space-separated list of scopes to request (e.g. \"assets:read assets:write\"). The returned `scopes` field is filtered down to the intersection of the requested scopes and the application's allowed scopes - it may be empty if none overlap. This endpoint never rejects a request just because it asked for scopes the application isn't allowed to have; every requested scope must still be one this platform supports, though.","in":"query","name":"scope","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Must be \"code\" for the Authorization Code flow.","example":"code","in":"query","name":"response_type","required":true,"schema":{"type":"string"},"style":"form"},{"description":"PKCE code challenge \u2014 the Base64url-encoded SHA-256 hash of the code_verifier. Required for all authorization requests.","in":"query","name":"code_challenge","required":true,"schema":{"type":"string"},"style":"form"},{"description":"The method used to derive the code_challenge. Only \"S256\" is supported; defaults to \"S256\" if omitted.","example":"S256","in":"query","name":"code_challenge_method","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuth2AuthorizeDescribeSchema"}}},"description":"Consent metadata (client name, authorizing user, system domain, scopes, redirect_uri, state)."},"400":{"description":"Bad request (invalid client_id, redirect_uri, scope, etc.)"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Validate the authorization request and return consent metadata"},"post":{"description":"the form body the authorization code is minted; otherwise the<br/>request is denied (``error=access_denied``).","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The OAuth2 application client ID","in":"query","name":"client_id","required":true,"schema":{"type":"string"},"style":"form"},{"description":"The URI to redirect to after authorization. Must exactly match one of the URIs registered for the application.","in":"query","name":"redirect_uri","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Space-separated list of scopes to request (e.g. \"assets:read assets:write\"). Unlike the GET describe step, this endpoint requires every requested scope to be within the application's allowed scopes and rejects the whole request otherwise (no partial grants), since this is the step that actually mints the authorization code. Every requested scope must also be one this platform supports.","in":"query","name":"scope","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Must be \"code\" for the Authorization Code flow.","example":"code","in":"query","name":"response_type","required":true,"schema":{"type":"string"},"style":"form"},{"description":"PKCE code challenge \u2014 the Base64url-encoded SHA-256 hash of the code_verifier. Required for all authorization requests.","in":"query","name":"code_challenge","required":true,"schema":{"type":"string"},"style":"form"},{"description":"The method used to derive the code_challenge. Only \"S256\" is supported; defaults to \"S256\" if omitted.","example":"S256","in":"query","name":"code_challenge_method","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuth2AuthorizeResponseSchema"}}},"description":"Redirect URI containing the authorization code."},"400":{"description":"Bad request (invalid client_id, redirect_uri, scope, etc.)"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Submit the user's consent decision. If ``confirm`` is present in"}},"/v1/oauth/token/":{"post":{"description":"","parameters":[{"description":"HTTP Basic credentials for a confidential client (``client_secret_basic``), as an alternative to sending client_id / client_secret in the form body.","in":"header","name":"Authorization","required":false,"schema":{"type":"string"},"style":"simple"},{"description":"The number of seconds the access token will be valid for. Defaults to, and is clamped by, the system default.","in":"query","name":"expires_in","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"client_id":{"description":"The OAuth2 client ID (application ID). Required unless the client authenticates with HTTP Basic.","type":"string"},"client_secret":{"description":"The OAuth2 client secret (required for the client_credentials grant unless sent as HTTP Basic credentials)","type":"string"},"code":{"description":"The authorization code (required for authorization_code grant)","type":"string"},"code_verifier":{"description":"The PKCE code verifier (required for authorization_code grant)","type":"string"},"grant_type":{"description":"The OAuth2 grant type","enum":["authorization_code","client_credentials","refresh_token"],"type":"string"},"redirect_uri":{"description":"The redirect URI used in the authorization request (required for authorization_code grant)","type":"string"},"refresh_token":{"description":"The refresh token (required for refresh_token grant)","type":"string"},"scope":{"description":"The requested scope. Used by the client_credentials grant, and by the refresh_token grant to request a subset of the scope already granted (a broader scope is rejected).","type":"string"}},"required":["grant_type"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenSchema"}}},"description":"Returns a new generated token for particular user"},"400":{"description":"Bad request"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Issue an OAuth token"}},"/v1/password/checks/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChecksSchema"}}},"description":"Password checks"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a list of password checks required for the password to be safe"}},"/v1/password/forgot/":{"post":{"description":"","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgotPasswordSchema"}}},"description":"body","required":true},"responses":{"201":{"description":"Reset password email was sent to an email"},"400":{"description":"Bad request"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Receives email address and sends email to this address with a link for resetting password."}},"/v1/password/reset/{reset_hash}/":{"put":{"description":"","parameters":[{"in":"path","name":"reset_hash","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Password was changed"},"400":{"description":"Bad request"},"419":{"description":"Authentication token expired"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Changes password to a new one"}},"/v1/password/{reset_hash}/checks/":{"get":{"description":"","parameters":[{"in":"path","name":"reset_hash","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChecksSchema"}}},"description":"Password checks"},"400":{"description":"Bad request"},"419":{"description":"Reset password token expired"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a list of password checks required for the password to be safe"}},"/v1/referral_codes/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralCodesSchema"}}},"description":"Returns a referral_code"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all referral_codes"},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralCodeSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralCodeSchema"}}},"description":"Returns a created referral_code"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"409":{"description":"Code already exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new referral_code"}},"/v1/referral_codes/{code}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"code","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a referral_code"},"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"code","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralCodeSchema"}}},"description":"Returns a referral_code"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a referral_code"}},"/v1/refresh/token/":{},"/v1/registrations/":{"post":{"description":"","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationSchema"}}},"description":"Returns a created registration"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new registration"}},"/v1/registrations/content/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Page route to fetch content for","in":"query","name":"page_route","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebflowContentSchema"}}},"description":"Returns page content from Webflow collection"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns page content from Webflow collection"}},"/v1/registrations/countries/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountriesSchema"}}},"description":"Returns a list of countries"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns list of countries"}},"/v1/registrations/verify/{email_hash}/":{"post":{"description":"","parameters":[{"in":"path","name":"email_hash","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationResponseSchema"}}},"description":"Returns a created system domain and login data if auto-login"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Verify email address, create system domain from template, and authenticate user"}},"/v1/system_domains/":{"get":{"deprecated":true,"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Query the name","in":"query","name":"query","schema":{"type":"string"},"style":"form"},{"description":"Comma separated list of statuses to show","in":"query","name":"statuses","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainsSchema"}}},"description":"Returns a list of system domains"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List of system domains"},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainSchema"}}},"description":"Returns a created system domain"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new system domain"}},"/v1/system_domains/basic/{system_domain_id}/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainBasicAdminSchema"}}},"description":"Returns a system domain"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"System domain does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular system domain without details"}},"/v1/system_domains/from_template/{template_id}/":{},"/v1/system_domains/referral_code/{referral_code}/":{"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"referral_code","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainFromReferralCodeSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainFromTemplateSchema"}}},"description":"Returns a created system domain"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new system domain from a referral code (That is associated to your domain)"}},"/v1/system_domains/search/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"page","required":false,"schema":{"default":1,"format":"int32","type":"integer"},"style":"form"},{"in":"query","name":"per_page","required":false,"schema":{"default":10,"format":"int32","type":"integer"},"style":"form"},{"description":"A semicolon separated list of `field,order` pairs. For example - name,asc;status,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"},{"description":"Query name, status, type, referral code or description","in":"query","name":"query","schema":{"type":"string"},"style":"form"},{"description":"Comma separated list of statuses to show","in":"query","name":"statuses","schema":{"type":"string"},"style":"form"},{"description":"Comma separated list of types to show","in":"query","name":"types","schema":{"type":"string"},"style":"form"},{"description":"filter by field_name","in":"query","name":"field_name","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainsSchema"}}},"description":"Returns a list of system domains"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List of system domains from Elasticsearch"}},"/v1/system_domains/templates/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainsSchema"}}},"description":"Returns a list of system domain templates"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"List of system domain templates"}},"/v1/system_domains/{system_domain_id}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular system_domain by id"},"get":{"description":"\nRequired roles:\n - can_read_system_domains\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainSchema"}}},"description":"Returns a system domain"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"System domain does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular system domain by id"},"patch":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainSuperAdminSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainSuperAdminSchema"}}},"description":"Returns an updated system domain"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"System domain does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update system domain"},"put":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainSuperAdminSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainSuperAdminSchema"}}},"description":"Returns an updated system domain"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"System domain does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update system domain"}},"/v1/system_domains/{system_domain_id}/e2e/":{"delete":{"description":"(For internal use. Should not be displayed in Swagger docs)","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular system_domain by id."}},"/v1/system_domains/{system_domain_id}/features/":{"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableSystemDomainFeatureSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableSystemDomainFeatureSchema"}}},"description":"Returns a created system domain"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Enable specified feature on a system domain"}},"/v1/system_domains/{system_domain_id}/logo/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"No body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"System domain does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete system domain logo image."},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"image/*":{"schema":{"properties":{"logo":{"format":"binary","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"logo":{"description":"Url for the system domain logo","type":"string"}},"type":"object"}}},"description":"Returns url for system domain logo"},"400":{"description":"Bad request"},"404":{"description":"System domain does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Upload system domain logo image."}},"/v1/system_domains/{system_domain_id}/profile/":{"patch":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainProfileSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemDomainProfileSchema"}}},"description":"Returns an updated system domain"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"System domain does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update system domain profile"}},"/v1/system_domains/{system_domain_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_read_system_domains\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"system_domain_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReindexSystemDomainSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Reindex system_domain"}}},"servers":[{"url":"/API/auth/"}]}