{"items":[{"type":"link","label":"Login Preferences","link":"/openapi/user/login-preferences.openapi","routeSlug":"/openapi/user/login-preferences.openapi","content":{"contentType":"overview","meta":{"name":"Login Preferences"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"login-preferences.openapi.json","url":"/_bundle/openapi/user/login-preferences.openapi.json?download"},{"kind":"download","label":"login-preferences.openapi.yaml","url":"/_bundle/openapi/user/login-preferences.openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"go","title":"Go","lang":"Go"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Login Preferences","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Manage your authentication methods"}],"sectionId":"/openapi/user/login-preferences.openapi"}],"sectionId":"/openapi/user/login-preferences.openapi"}]}]}},{"label":"Get login methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/login-preferences.openapi/other/getloginpreferencesbyappbyid","routeSlug":"/openapi/user/login-preferences.openapi/other/getloginpreferencesbyappbyid","metadata":{"seo":{"title":"Get login methods","description":"Retrieves all login methods for a specific application. Required permissions: apps:read, *:read, config:read, authentication-methods:read, [appId]:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLoginPreferencesByAppById","name":"Get login methods","isWebhook":false,"pointer":"/paths/~1loginPreferences~1{appId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get login methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves all login methods for a specific application. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication-methods:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_394","description":"ID of the application whose login methods you want to retrieve","required":true}],"pointer":"/paths/~1loginPreferences~1{appId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loginPreferences/{appId}","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_394"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/loginPreferences/{appId}","href":"other/getloginpreferencesbyappbyid","openApiOperationId":"getLoginPreferencesByAppById","summary":"Get login methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"},{"code":"404","description":"Application Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1loginPreferences~1{appId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/loginPreferences/{appId}"},{"label":"Update login methods","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/login-preferences.openapi/other/updateappauthmethods","routeSlug":"/openapi/user/login-preferences.openapi/other/updateappauthmethods","metadata":{"seo":{"title":"Update login methods","description":"Updates login methods of a specific application. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one. Required permissions: apps:edit, *:edit, config:edit, authentication-methods:edit, [appId]:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAppAuthMethods","name":"Update login methods","isWebhook":false,"pointer":"/paths/~1loginPreferences~1{appId}~1authMethods/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update login methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates login methods of a specific application. Note: Fields that are objects cannot be partially updated, since the new value you set will just replace the current one. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication-methods:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_394","description":"ID of the application to update auth methods for","required":true}],"pointer":"/paths/~1loginPreferences~1{appId}~1authMethods/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdateAuthMethodsInput"}},"schemaId":"components/schemas/ApiUpdateAuthMethodsInput","pointer":"/paths/~1loginPreferences~1{appId}~1authMethods/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/loginPreferences/{appId}/authMethods","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_394"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiUpdateAuthMethodsInput"}},"responseCodes":["200","400","404"],"pointer":"/loginPreferences/{appId}/authMethods","href":"other/updateappauthmethods","openApiOperationId":"updateAppAuthMethods","summary":"Update login methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiUpdateAuthMethodsInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdateAuthMethodsInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}},"schemaId":"schema_396"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"},{"code":"404","description":"Application Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1loginPreferences~1{appId}~1authMethods/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_396","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/loginPreferences/{appId}/authMethods"},{"label":"Create password dictionary","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/login-preferences.openapi/other/createpassworddictionary","routeSlug":"/openapi/user/login-preferences.openapi/other/createpassworddictionary","metadata":{"seo":{"title":"Create password dictionary","description":"Create a password dictionary for a specific application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPasswordDictionary","name":"Create password dictionary","isWebhook":false,"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create password dictionary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a password dictionary for a specific application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_394","required":true}],"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCreatePasswordDictionaryInput"}},"schemaId":"components/schemas/ApiCreatePasswordDictionaryInput","pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/applications/{appId}/password-dictionary","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_394"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiCreatePasswordDictionaryInput"}},"responseCodes":["201","400"],"pointer":"/v1/applications/{appId}/password-dictionary","href":"other/createpassworddictionary","openApiOperationId":"createPasswordDictionary","summary":"Create password dictionary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiCreatePasswordDictionaryInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCreatePasswordDictionaryInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}},"schemaId":"schema_397"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"}],"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_397","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/applications/{appId}/password-dictionary"},{"label":"Get password dictionary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/login-preferences.openapi/other/getpassworddictionary","routeSlug":"/openapi/user/login-preferences.openapi/other/getpassworddictionary","metadata":{"seo":{"title":"Get password dictionary","description":"Get password dictionary for specified application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPasswordDictionary","name":"Get password dictionary","isWebhook":false,"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get password dictionary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get password dictionary for specified application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_394","required":true}],"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/applications/{appId}/password-dictionary","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_394"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/applications/{appId}/password-dictionary","href":"other/getpassworddictionary","openApiOperationId":"getPasswordDictionary","summary":"Get password dictionary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"}],"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}}],"examples":[]}]}]}]},"httpPath":"/v1/applications/{appId}/password-dictionary"},{"label":"Add words to password dictionary","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/login-preferences.openapi/other/updatepassworddictionary","routeSlug":"/openapi/user/login-preferences.openapi/other/updatepassworddictionary","metadata":{"seo":{"title":"Add words to password dictionary","description":"Add words to password dictionary for a specific application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePasswordDictionary","name":"Add words to password dictionary","isWebhook":false,"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary~1add/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add words to password dictionary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add words to password dictionary for a specific application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_394","required":true}],"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary~1add/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput"}},"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput","pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary~1add/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/applications/{appId}/password-dictionary/add","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_394"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput"}},"responseCodes":["200","400","404"],"pointer":"/v1/applications/{appId}/password-dictionary/add","href":"other/updatepassworddictionary","openApiOperationId":"updatePasswordDictionary","summary":"Add words to password dictionary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}},"schemaId":"schema_399"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary~1add/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_399","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/applications/{appId}/password-dictionary/add"},{"label":"Remove words from password dictionary","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/login-preferences.openapi/other/deletepassworddictionary","routeSlug":"/openapi/user/login-preferences.openapi/other/deletepassworddictionary","metadata":{"seo":{"title":"Remove words from password dictionary","description":"Remove words from password dictionary for a specific application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePasswordDictionary","name":"Remove words from password dictionary","isWebhook":false,"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary~1remove/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove words from password dictionary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove words from password dictionary for a specific application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_394","required":true}],"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary~1remove/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput"}},"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput","pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary~1remove/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/applications/{appId}/password-dictionary/remove","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_394"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput"}},"responseCodes":["200","400","404"],"pointer":"/v1/applications/{appId}/password-dictionary/remove","href":"other/deletepassworddictionary","openApiOperationId":"deletePasswordDictionary","summary":"Remove words from password dictionary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiUpdatePasswordDictionaryInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}},"schemaId":"components/schemas/NotFoundHttpError"}],"pointer":"/paths/~1v1~1applications~1{appId}~1password-dictionary~1remove/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}},{"code":"404","schemaId":"components/schemas/NotFoundHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/applications/{appId}/password-dictionary/remove"}],"store":{"schemaStore":{"components/schemas/BadRequestHttpError":{"id":"components/schemas/BadRequestHttpError","kind":"json-schema","title":"BadRequestHttpError","data":{"type":"object","properties":{"message":{"example":"Bad request","type":"array","items":{"type":"string"}},"error_code":{"type":"number","example":400}},"required":["message","error_code"]}},"components/schemas/NotFoundHttpError":{"id":"components/schemas/NotFoundHttpError","kind":"json-schema","title":"NotFoundHttpError","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number","example":404}},"required":["message","error_code"]}},"components/schemas/ApiLoginPreferences":{"id":"components/schemas/ApiLoginPreferences","kind":"json-schema","title":"ApiLoginPreferences","data":{"type":"object","properties":{"auth_methods":{"description":"Login preferences","allOf":[{"$ref":"#/components/schemas/ApiAuthMethods"}]}},"required":["auth_methods"]}},"components/schemas/ApiUpdateAuthMethodsInput":{"id":"components/schemas/ApiUpdateAuthMethodsInput","kind":"json-schema","title":"ApiUpdateAuthMethodsInput","data":{"type":"object","properties":{"email":{"description":"Email magic link login configuration","allOf":[{"$ref":"#/components/schemas/EmailConfiguration"}]},"email_otp":{"description":"Email one time password login configuration","allOf":[{"$ref":"#/components/schemas/EmailOtpConfiguration"}]},"sms":{"description":"SMS one time password login configuration","allOf":[{"$ref":"#/components/schemas/SMSConfiguration"}]},"password":{"description":"Password login configuration","allOf":[{"$ref":"#/components/schemas/PasswordConfiguration"}]},"totp":{"description":"TOTP login configuration","allOf":[{"$ref":"#/components/schemas/TotpConfiguration"}]},"pin_authenticator":{"description":"PIN authenticator login configuration","allOf":[{"$ref":"#/components/schemas/PinAuthenticatorConfiguration"}]},"face":{"description":"Face authenticator login configuration","allOf":[{"$ref":"#/components/schemas/FaceAuthenticatorConfiguration"}]},"webauthn_api":{"description":"WebAuthn API login configuration","allOf":[{"$ref":"#/components/schemas/WebAuthnApiConfiguration"}]},"google":{"description":"Google login configuration","allOf":[{"$ref":"#/components/schemas/ClientSecretConfiguration"}]},"line":{"description":"Line login configuration","allOf":[{"$ref":"#/components/schemas/ClientSecretConfiguration"}]},"apple":{"description":"Apple login configuration","allOf":[{"$ref":"#/components/schemas/AppleConfiguration"}]},"facebook":{"description":"Facebook login configuration","allOf":[{"$ref":"#/components/schemas/ClientSecretConfiguration"}]},"push":{"description":"Push login configuration","allOf":[{"$ref":"#/components/schemas/PushConfiguration"}]},"tiktok":{"description":"Tiktok login configuration","allOf":[{"$ref":"#/components/schemas/ClientSecretConfiguration"}]}}}},"components/schemas/ApiCreatePasswordDictionaryInput":{"id":"components/schemas/ApiCreatePasswordDictionaryInput","kind":"json-schema","title":"ApiCreatePasswordDictionaryInput","data":{"type":"object","properties":{"words":{"description":"List of forbidden words","type":"array","items":{"type":"string"}}},"required":["words"]}},"components/schemas/PasswordDictionaryResponse":{"id":"components/schemas/PasswordDictionaryResponse","kind":"json-schema","title":"PasswordDictionaryResponse","data":{"type":"object","properties":{"tenant_id":{"type":"string","description":"Tenant ID"},"app_id":{"type":"string","description":"Application ID"},"words":{"description":"List of forbidden words","type":"array","items":{"type":"string"}}},"required":["tenant_id","app_id","words"]}},"components/schemas/ApiUpdatePasswordDictionaryInput":{"id":"components/schemas/ApiUpdatePasswordDictionaryInput","kind":"json-schema","title":"ApiUpdatePasswordDictionaryInput","data":{"type":"object","properties":{"words":{"description":"List of words","type":"array","items":{"type":"string"}}},"required":["words"]}},"components/schemas/ApiAuthMethods":{"id":"components/schemas/ApiAuthMethods","kind":"json-schema","title":"ApiAuthMethods","data":{"type":"object","properties":{"google":{"description":"Google login configuration","allOf":[{"$ref":"#/components/schemas/ClientSecretConfiguration"}]},"facebook":{"description":"Facebook login configuration","allOf":[{"$ref":"#/components/schemas/ClientSecretConfiguration"}]},"email":{"description":"Email magic link login configuration","allOf":[{"$ref":"#/components/schemas/EmailConfiguration"}]},"email_otp":{"description":"Email one time password login configuration","allOf":[{"$ref":"#/components/schemas/EmailOtpConfiguration"}]},"apple":{"description":"Apple login configuration","allOf":[{"$ref":"#/components/schemas/AppleConfiguration"}]},"sms":{"description":"SMS one time password login configuration","allOf":[{"$ref":"#/components/schemas/SMSConfiguration"}]},"webauthn_api":{"description":"WebAuthn API configuration","allOf":[{"$ref":"#/components/schemas/WebAuthnApiConfiguration"}]},"line":{"description":"Line login configuration","allOf":[{"$ref":"#/components/schemas/ClientSecretConfiguration"}]},"password":{"description":"Password login configuration","allOf":[{"$ref":"#/components/schemas/PasswordConfiguration"}]},"totp":{"description":"TOTP login configuration","allOf":[{"$ref":"#/components/schemas/TotpConfiguration"}]},"push":{"description":"Push configuration","allOf":[{"$ref":"#/components/schemas/PushConfiguration"}]},"tiktok":{"description":"TikTok login configuration","allOf":[{"$ref":"#/components/schemas/ClientSecretConfiguration"}]},"pin_authenticator":{"description":"PIN authenticator configuration","allOf":[{"$ref":"#/components/schemas/PinAuthenticatorConfiguration"}]},"face":{"description":"Face authenticator configuration","allOf":[{"$ref":"#/components/schemas/FaceAuthenticatorConfiguration"}]}}}},"components/schemas/EmailConfiguration":{"id":"components/schemas/EmailConfiguration","kind":"json-schema","title":"EmailConfiguration","data":{"type":"object","properties":{"expiresIn":{"type":"number","description":"Number of minutes until the email link/code expires"},"linksPerUser":{"type":"number","description":"Allowed magic links to send a user per minute"},"message":{"$ref":"#/components/schemas/MessageConfiguration"}},"required":["expiresIn","linksPerUser","message"]}},"components/schemas/EmailOtpConfiguration":{"id":"components/schemas/EmailOtpConfiguration","kind":"json-schema","title":"EmailOtpConfiguration","data":{"type":"object","properties":{"expiresIn":{"type":"number","description":"Number of minutes until the OTP expires"},"lockoutDuration":{"type":"number","description":"OTP lockout duration (in minutes) after maximum attempts are reached","example":15},"maxFailures":{"type":"number","description":"Number of wrong OTP attempts allowed before the passcode is invalidated. Must be between 1 and 20.","example":3},"codeLength":{"type":"number","description":"The length of the generated OTP code. Must be between 4 and 8.","example":6},"crossClientsAllowed":{"type":"boolean","description":"Determines if OTP authentication is allowed across different clients within the same application","default":false},"message":{"$ref":"#/components/schemas/MessageConfiguration"}},"required":["expiresIn","maxFailures","message"]}},"components/schemas/SMSConfiguration":{"id":"components/schemas/SMSConfiguration","kind":"json-schema","title":"SMSConfiguration","data":{"type":"object","properties":{"expiresIn":{"type":"number","description":"Number of minutes until the OTP expires"},"lockoutDuration":{"type":"number","description":"OTP lockout duration (in minutes) after maximum attempts are reached","example":15},"maxFailures":{"type":"number","description":"Number of wrong OTP attempts allowed before the passcode is invalidated. Must be between 1 and 20.","example":3},"codeLength":{"type":"number","description":"The length of the generated OTP code. Must be between 4 and 8.","example":6},"crossClientsAllowed":{"type":"boolean","description":"Determines if OTP authentication is allowed across different clients within the same application","default":false}},"required":["expiresIn","maxFailures"]}},"components/schemas/PasswordConfiguration":{"id":"components/schemas/PasswordConfiguration","kind":"json-schema","title":"PasswordConfiguration","data":{"type":"object","properties":{"failuresExpireIn":{"type":"number","description":"Number of minutes until previous failed attempts are considered expired. Must be between 1 and 525600 minutes (1 year).","default":15,"example":15,"minimum":1,"maximum":525600},"lockoutTiers":{"description":"Progressive lockout tiers based on failed attempts","type":"array","items":{"$ref":"#/components/schemas/LockoutTier"}},"resetValidityMinutes":{"type":"number","description":"Number of minutes until reset password token/OTP expires.","default":5,"example":5,"minimum":5,"maximum":60},"passwordComplexity":{"type":"number","description":"Password complexity. Must be between 1 and 5.","default":5,"example":5,"minimum":1,"maximum":5},"passwordMinLength":{"type":"number","description":"Minimum required length of the password.","default":14,"example":14,"minimum":5,"maximum":14},"blockPreviousPasswords":{"type":"number","description":"Number of most recent passwords to block the user from setting as their new password.","default":0,"example":0,"minimum":0,"maximum":20},"checkHibp":{"type":"boolean","description":"Check password updates against HIBP.","default":false},"checkDictionary":{"type":"boolean","description":"Check password updates against a predefined dictionary.","default":false},"passwordExpiresIn":{"type":"number","description":"Number of days until the password expires. Must be between 1 and 1096 days (3 years).","default":90,"example":90,"minimum":1,"maximum":1096},"ignoreExpiration":{"type":"boolean","description":"Ignore password expiration. If true, the password will never expire.","default":false},"maxPasswordFailures":{"type":"number","description":"Number of wrong password attempts allowed before the user is suspended. Must be between 1 and 20.","default":5,"example":5,"minimum":1,"maximum":20},"passwordSuspensionDuration":{"type":"number","description":"Number of minutes to suspend the user from authenticating using password after the maximum number of allowed failed attempts is exceeded. Must be between 1 and 525600 minutes (1 year).","default":15,"example":15,"minimum":1,"maximum":525600},"tempPasswordValidityHours":{"type":"number","description":"Number of hours until temporary passwords are considered expired. Must be between 1 and 8760 hours (1 year).","example":24,"minimum":1,"maximum":8760},"message":{"$ref":"#/components/schemas/MessageConfiguration"},"requireMFA":{"type":"boolean","description":"Require multi-factor authentication for password reset flows.","default":false},"codeLength":{"type":"number","description":"The length of the generated OTP code. Must be between 4 and 8.","example":6},"notifyOnPasswordUpdate":{"type":"boolean","default":false,"description":"Send email to end-user upon password update"}},"required":["resetValidityMinutes","passwordComplexity","passwordMinLength","blockPreviousPasswords","passwordExpiresIn","message"]}},"components/schemas/TotpConfiguration":{"id":"components/schemas/TotpConfiguration","kind":"json-schema","title":"TotpConfiguration","data":{"type":"object","properties":{"failuresExpireIn":{"type":"number","description":"Number of minutes until previous failed attempts are considered expired. Must be between 1 and 525600 minutes (1 year).","default":15,"example":15,"minimum":1,"maximum":525600},"lockoutTiers":{"description":"Progressive lockout tiers based on failed attempts","type":"array","items":{"$ref":"#/components/schemas/LockoutTier"}},"algorithm":{"type":"string","enum":["sha1","sha256","sha512"],"description":"The algorithm used to generate the TOTP code","default":"sha1"},"digits":{"type":"number","description":"Number of digits in the generated TOTP code, must be 6 or 8","example":6,"default":6},"period":{"type":"number","description":"Number of seconds in which the TOTP code is valid","example":30,"default":30},"window":{"type":"number","description":"Number of windows to check for valid TOTP codes","example":2,"default":1},"issuer":{"type":"string","description":"TOTP issuer","example":"My Company"},"maxFailures":{"type":"number","description":"Number of wrong TOTP attempts allowed before the passcode is invalidated. Must be between 1 and 20.","example":3,"default":5,"deprecated":true},"lockoutDuration":{"type":"number","description":"TOTP lockout duration (in minutes) after maximum attempts are reached","example":15,"default":15,"deprecated":true},"maxTotpPerUser":{"type":"number","description":"Maximum number of TOTP authenticators allowed per user. Must be between 1 and 50.","example":1,"default":1}}}},"components/schemas/PinAuthenticatorConfiguration":{"id":"components/schemas/PinAuthenticatorConfiguration","kind":"json-schema","title":"PinAuthenticatorConfiguration","data":{"type":"object","properties":{"failuresExpireIn":{"type":"number","description":"Number of minutes until previous failed attempts are considered expired. Must be between 1 and 525600 minutes (1 year).","default":15,"example":15,"minimum":1,"maximum":525600},"lockoutTiers":{"description":"Progressive lockout tiers based on failed attempts","type":"array","items":{"$ref":"#/components/schemas/LockoutTier"}},"maxFailures":{"type":"number","description":"Number of wrong PIN Authenticator attempts allowed before the passcode is invalidated. Must be between 1 and 20.","example":3,"default":5,"deprecated":true},"lockoutDuration":{"type":"number","description":"PIN Authenticator lockout duration (in minutes) after maximum attempts are reached","example":15,"default":15,"deprecated":true}}}},"components/schemas/FaceAuthenticatorConfiguration":{"id":"components/schemas/FaceAuthenticatorConfiguration","kind":"json-schema","title":"FaceAuthenticatorConfiguration","data":{"type":"object","properties":{"failuresExpireIn":{"type":"number","description":"Number of minutes until previous failed attempts are considered expired. Must be between 1 and 525600 minutes (1 year).","default":15,"example":15,"minimum":1,"maximum":525600},"lockoutTiers":{"description":"Progressive lockout tiers based on failed attempts","type":"array","items":{"$ref":"#/components/schemas/LockoutTier"}},"maxFailures":{"type":"number","description":"Number of wrong Face Authenticator attempts allowed. Must be between 1 and 20.","example":3,"default":5,"deprecated":true},"lockoutDuration":{"type":"number","description":"Face Authenticator lockout duration (in minutes) after maximum attempts are reached","example":15,"default":15,"deprecated":true},"saveImageEmbedding":{"type":"boolean","description":"Enables saving the image embedding","default":true}}}},"components/schemas/WebAuthnApiConfiguration":{"id":"components/schemas/WebAuthnApiConfiguration","kind":"json-schema","title":"WebAuthnApiConfiguration","data":{"type":"object","properties":{"failuresExpireIn":{"type":"number","description":"Number of minutes until previous failed attempts are considered expired. Must be between 1 and 525600 minutes (1 year).","default":15,"example":15,"minimum":1,"maximum":525600},"lockoutTiers":{"description":"Progressive lockout tiers based on failed attempts","type":"array","items":{"$ref":"#/components/schemas/LockoutTier"}},"rpId":{"type":"string","description":"Domain to which WebAuthn credentials are registered and used to authenticate (e.g., example.com)"},"rpWebOrigins":{"description":"A list of Web origins that will be used to request registration and authentication. The origin must match the domain of the RP ID, but may be a subdomain of the RP ID (e.g., https://login.example.com ). The origin must also include the HTTPS scheme and port (if relevant).","type":"array","items":{"type":"string"}},"rpMobileOrigins":{"description":"A list of mobile origins that will be used to request registration and authentication. The origin must match the domain of the RP ID.","type":"array","items":{"type":"string"}},"replaceExistingPasskey":{"type":"boolean","description":"Set to true in order to replace the existing passkey. Default is False.","default":false},"maxFailures":{"type":"number","description":"Number of wrong attempts allowed before the passcode is invalidated. Must be between 1 and 20.","example":3,"default":5,"deprecated":true},"lockoutDuration":{"type":"number","description":"Lockout duration (in minutes) after maximum attempts are reached","example":15,"default":15,"deprecated":true},"allowSyncedPasskeys":{"type":"boolean","description":"Allow synced passkeys","default":true},"enforceAttestation":{"type":"boolean","description":"Enforce attestation for device-bound passkeys","default":false},"attestationType":{"type":"string","enum":["none","indirect","direct"],"description":"Attestation conveyance preference (none, indirect, or direct)","default":"none"},"aaguidAllowList":{"description":"List of allowed AAGUIDs (Authenticator Attestation GUIDs). If specified, only authenticators with these AAGUIDs will be accepted. Mutually exclusive with aaguidBlockList.","type":"array","items":{"type":"string"}},"aaguidBlockList":{"description":"List of blocked AAGUIDs (Authenticator Attestation GUIDs). Authenticators with these AAGUIDs will be rejected. Mutually exclusive with aaguidAllowList.","type":"array","items":{"type":"string"}},"rpOrigin":{"type":"string","deprecated":true,"description":"Web origin that will be used to request registration and authentication. The origin must match the domain of the RP ID, but may be a subdomain of the RP ID (e.g., https://login.example.com ). The origin must also include the HTTPS scheme and port (if relevant)."},"rpOrigins":{"deprecated":true,"description":"Use rpWebOrigins or rpMobileOrigins instead","type":"array","items":{"type":"string"}}},"required":["rpId"]}},"components/schemas/ClientSecretConfiguration":{"id":"components/schemas/ClientSecretConfiguration","kind":"json-schema","title":"ClientSecretConfiguration","data":{"type":"object","properties":{"clientId":{"type":"string","description":"Client ID retrieved from the identity provider"},"clientSecret":{"type":"string","description":"Client Secret retrieved from the identity provider"},"redirectUris":{"description":"List of URIs approved for redirects for your client","example":["https://www.example.com/login"],"type":"array","items":{"type":"string"}}},"required":["clientId"]}},"components/schemas/AppleConfiguration":{"id":"components/schemas/AppleConfiguration","kind":"json-schema","title":"AppleConfiguration","data":{"type":"object","properties":{"clientId":{"type":"string","description":"Services ID retrieved from Apple"},"clientSecret":{"type":"string","description":"Client Secret Signing Key retrieved from Apple"},"redirectUris":{"description":"List of URIs approved for redirects for your client","example":["https://www.example.com/login"],"type":"array","items":{"type":"string"}},"appleTeamId":{"type":"string","description":"Apple Team ID"},"keyId":{"type":"string","description":"Apple Key ID"}},"required":["clientId","appleTeamId","keyId"]}},"components/schemas/PushConfiguration":{"id":"components/schemas/PushConfiguration","kind":"json-schema","title":"PushConfiguration","data":{"type":"object","properties":{"apn":{"description":"APN configuration. Can be a single object or an array of objects.","oneOf":[{"$ref":"#/components/schemas/APNConfiguration"},{"type":"array","items":{"$ref":"#/components/schemas/APNConfiguration"}}],"items":{"type":"string"}},"fcm":{"description":"FCM configuration","allOf":[{"$ref":"#/components/schemas/FcmConfiguration"}]}}}},"components/schemas/MessageConfiguration":{"id":"components/schemas/MessageConfiguration","kind":"json-schema","title":"MessageConfiguration","data":{"type":"object","properties":{"primaryColor":{"type":"string","description":"Primary color of the email, specified as a Hex color"},"from":{"type":"string","description":"Origin of the email message"},"subject":{"type":"string","description":"Subject of the email message"}},"required":["primaryColor"]}},"components/schemas/LockoutTier":{"id":"components/schemas/LockoutTier","kind":"json-schema","title":"LockoutTier","data":{"type":"object","properties":{"attempts":{"type":"number","description":"Number of failed attempts before this tier is triggered","example":3,"minimum":1},"duration":{"type":"number","description":"Lockout duration in minutes for this tier","example":15,"minimum":1,"maximum":525600}},"required":["attempts","duration"]}},"components/schemas/APNConfiguration":{"id":"components/schemas/APNConfiguration","kind":"json-schema","title":"APNConfiguration","data":{"type":"object","properties":{"key":{"type":"string","description":"APN key"},"keyId":{"type":"string","description":"APN key id"},"teamId":{"type":"string","description":"APN team id"},"bundle":{"type":"string","description":"APN bundle"},"isProduction":{"type":"boolean","description":"Is Production APN Environment"}},"required":["key","keyId","teamId","bundle"]}},"components/schemas/FcmConfiguration":{"id":"components/schemas/FcmConfiguration","kind":"json-schema","title":"FcmConfiguration","data":{"type":"object","properties":{"key":{"type":"object","description":"FCM key"}},"required":["key"]}},"schema_394":{"kind":"json-schema","data":{"type":"string"},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"title":"ApiOkResponse-getLoginPreferencesByAppById","type":"object","required":["result"],"description":"Successfully fetched app login preferences","properties":{"result":{"$ref":"#/components/schemas/ApiLoginPreferences"}}},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"title":"ApiOkResponse-updateAppAuthMethods","type":"object","required":["result"],"description":"Methods updated","properties":{"result":{"$ref":"#/components/schemas/ApiLoginPreferences"}}},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"title":"ApiCreatedResponse-createPasswordDictionary","type":"object","required":["result"],"description":"Password dictionary created","properties":{"result":{"$ref":"#/components/schemas/PasswordDictionaryResponse"}}},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"title":"ApiOkResponse-getPasswordDictionary","type":"object","required":["result"],"description":"","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/PasswordDictionaryResponse"}}}},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"title":"ApiOkResponse-updatePasswordDictionary","type":"object","required":["result"],"description":"Password dictionary updated","properties":{"result":{"$ref":"#/components/schemas/PasswordDictionaryResponse"}}},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"title":"ApiOkResponse-deletePasswordDictionary","type":"object","required":["result"],"description":"Password dictionary updated","properties":{"result":{"$ref":"#/components/schemas/PasswordDictionaryResponse"}}},"id":"schema_400"}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},"UserAccessToken":{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"},"AdminAccessToken":{"id":"AdminAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"ClientAccessToken":{"id":"ClientAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"OrgAdminAccessToken":{"id":"OrgAdminAccessToken","type":"oauth2","description":"A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}},"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSchemaTitles":true,"onlyRequiredInSamples":false,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":false,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/user/login-preferences.openapi.json?download"},{"url":"/_bundle/openapi/user/login-preferences.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Login Preferences","description":"Manage your authentication methods"}},"baseSlug":"/openapi/user/login-preferences.openapi","routesMapping":{}}