{"items":[{"type":"link","label":"Passwords","link":"/openapi/user/passwords.openapi","routeSlug":"/openapi/user/passwords.openapi","content":{"contentType":"overview","meta":{"name":"Passwords"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"passwords.openapi.json","url":"/_bundle/openapi/user/passwords.openapi.json?download"},{"kind":"download","label":"passwords.openapi.yaml","url":"/_bundle/openapi/user/passwords.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":"Passwords","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Login users using passwords. This implements a frontend integration for password authentication, where passwords are handled only by the client. If the password credentials are valid, the client can obtain an authorization code that your app can exchange in the backend for user tokens."}],"sectionId":"/openapi/user/passwords.openapi"}],"sectionId":"/openapi/user/passwords.openapi"}]}]}},{"label":"Login with password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/login","routeSlug":"/openapi/user/passwords.openapi/other/login","metadata":{"seo":{"title":"Login with password","description":"Authenticate a user with a password"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"login","name":"Login with password","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1login/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login with password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Authenticate a user with a password"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiPasswordLoginInput"}},"schemaId":"components/schemas/ApiPasswordLoginInput","pointer":"/paths/~1v1~1auth~1password~1login/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/login","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiPasswordLoginInput"}},"responseCodes":["200","401","403"],"pointer":"/v1/auth/password/login","href":"other/login","openApiOperationId":"login","summary":"Login with password"},"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/ApiPasswordLoginInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiPasswordLoginInput"}},"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_436"}},"schemaId":"schema_436"},{"code":"401","description":"When the  username/email and password don't match or don't exist"},{"code":"403","description":"When the user has to change the password","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResetPasswordRequiredErrorResponse"}},"schemaId":"components/schemas/ApiResetPasswordRequiredErrorResponse"}],"pointer":"/paths/~1v1~1auth~1password~1login/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_436","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ApiResetPasswordRequiredErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResetPasswordRequiredErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/login"},{"label":"Start reset by email link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/sendforgotpasswordemail","routeSlug":"/openapi/user/passwords.openapi/other/sendforgotpasswordemail","metadata":{"seo":{"title":"Start reset by email link","description":"Starts a password reset flow by sending an email magic link. Once clicked, the User Agent will be redirected to the URI specified in this request. This URI will include a code required to reset the password. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendForgotPasswordEmail","name":"Start reset by email link","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1reset~1email~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start reset by email link","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":"Starts a password reset flow by sending an email magic link. Once clicked, the User Agent will be redirected to the URI specified in this request. This URI will include a code required to reset the password. "},"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:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordEmailLinkInput"}},"schemaId":"components/schemas/ApiSendResetPasswordEmailLinkInput","pointer":"/paths/~1v1~1auth~1password~1reset~1email~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/reset/email/link","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordEmailLinkInput"}},"responseCodes":["200","400","403","404","503"],"pointer":"/v1/auth/password/reset/email/link","href":"other/sendforgotpasswordemail","openApiOperationId":"sendForgotPasswordEmail","summary":"Start reset by email link"},"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/ApiSendResetPasswordEmailLinkInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordEmailLinkInput"}},"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":"components/schemas/ApiSendResetPasswordEmailResponse"}},"schemaId":"components/schemas/ApiSendResetPasswordEmailResponse"},{"code":"400","description":"Invalid redirect URI","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437"},{"code":"403","description":"When the email of the user is not verified","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}},"schemaId":"schema_438"},{"code":"404","description":"When there is no user with the requested email as a primary email in the tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}},"schemaId":"schema_439"},{"code":"503","description":"Error occurred while sending email","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440"}],"pointer":"/paths/~1v1~1auth~1password~1reset~1email~1link/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiSendResetPasswordEmailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordEmailResponse"}}},{"code":"400","schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}}},{"code":"403","schemaId":"schema_438","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}}},{"code":"404","schemaId":"schema_439","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}}},{"code":"503","schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/reset/email/link"},{"label":"Generate reset link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/generateresetpasswordlink","routeSlug":"/openapi/user/passwords.openapi/other/generateresetpasswordlink","metadata":{"seo":{"title":"Generate reset link","description":"Starts a password reset flow by generating a magic link. Once clicked, the User Agent will be redirected to the URI specified in this request. This URI will include a code required to reset the password. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateResetPasswordLink","name":"Generate reset link","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1reset~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate reset link","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":"Starts a password reset flow by generating a magic link. Once clicked, the User Agent will be redirected to the URI specified in this request. This URI will include a code required to reset the password. "},"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:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiGenerateResetPasswordLinkInput"}},"schemaId":"components/schemas/ApiGenerateResetPasswordLinkInput","pointer":"/paths/~1v1~1auth~1password~1reset~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/reset/link","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiGenerateResetPasswordLinkInput"}},"responseCodes":["200","400","404"],"pointer":"/v1/auth/password/reset/link","href":"other/generateresetpasswordlink","openApiOperationId":"generateResetPasswordLink","summary":"Generate reset link"},"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/ApiGenerateResetPasswordLinkInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiGenerateResetPasswordLinkInput"}},"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":"components/schemas/ApiGenerateResetPasswordLinkResponse"}},"schemaId":"components/schemas/ApiGenerateResetPasswordLinkResponse"},{"code":"400","description":"Invalid redirect URI","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437"},{"code":"404","description":"When there is no user with the requested email as a primary email in the tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441"}},"schemaId":"schema_441"}],"pointer":"/paths/~1v1~1auth~1password~1reset~1link/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGenerateResetPasswordLinkResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGenerateResetPasswordLinkResponse"}}},{"code":"400","schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}}},{"code":"404","schemaId":"schema_441","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/reset/link"},{"label":"Start reset by Email OTP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/sendresetpasswordemailotp","routeSlug":"/openapi/user/passwords.openapi/other/sendresetpasswordemailotp","metadata":{"seo":{"title":"Start reset by Email OTP","description":"Starts a password reset flow by sending an Email OTP. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendResetPasswordEmailOTP","name":"Start reset by Email OTP","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1reset~1email~1otp/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start reset by Email OTP","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":"Starts a password reset flow by sending an Email OTP. "},"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:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordEmailOtpInput"}},"schemaId":"components/schemas/ApiSendResetPasswordEmailOtpInput","pointer":"/paths/~1v1~1auth~1password~1reset~1email~1otp/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/reset/email/otp","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordEmailOtpInput"}},"responseCodes":["200","403","404","503"],"pointer":"/v1/auth/password/reset/email/otp","href":"other/sendresetpasswordemailotp","openApiOperationId":"sendResetPasswordEmailOTP","summary":"Start reset by Email OTP"},"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/ApiSendResetPasswordEmailOtpInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordEmailOtpInput"}},"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":"components/schemas/ApiSendResetPasswordEmailOtpResponse"}},"schemaId":"components/schemas/ApiSendResetPasswordEmailOtpResponse"},{"code":"403","description":"When the email of the user is not verified, a forbidden error will be returned","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}},"schemaId":"schema_442"},{"code":"404","description":"When there is no user with the requested email address as primary email address in the tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_443"}},"schemaId":"schema_443"},{"code":"503","description":"Error occurred while sending email","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440"}],"pointer":"/paths/~1v1~1auth~1password~1reset~1email~1otp/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiSendResetPasswordEmailOtpResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordEmailOtpResponse"}}},{"code":"403","schemaId":"schema_442","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}}},{"code":"404","schemaId":"schema_443","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_443"}}},{"code":"503","schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/reset/email/otp"},{"label":"Validate reset OTP Email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/validateresetpasswordemailotp","routeSlug":"/openapi/user/passwords.openapi/other/validateresetpasswordemailotp","metadata":{"seo":{"title":"Validate reset OTP Email","description":"Validate a reset password OTP. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateResetPasswordEmailOTP","name":"Validate reset OTP Email","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1reset~1email~1otp~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate reset OTP Email","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":"Validate a reset password OTP. "},"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:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiVerifyResetEmailOtpInput"}},"schemaId":"components/schemas/ApiVerifyResetEmailOtpInput","pointer":"/paths/~1v1~1auth~1password~1reset~1email~1otp~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/reset/email/otp/validate","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiVerifyResetEmailOtpInput"}},"responseCodes":["200","400","403","404"],"pointer":"/v1/auth/password/reset/email/otp/validate","href":"other/validateresetpasswordemailotp","openApiOperationId":"validateResetPasswordEmailOTP","summary":"Validate reset OTP Email"},"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/ApiVerifyResetEmailOtpInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiVerifyResetEmailOtpInput"}},"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":"components/schemas/ApiValidateResetPasswordResponse"}},"schemaId":"components/schemas/ApiValidateResetPasswordResponse"},{"code":"400","description":"Invalid phone number, email, username or passcode","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}},"schemaId":"schema_444"},{"code":"403","description":"When the provided OTP is expired or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445"},{"code":"404","description":"When the requested user does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}},"schemaId":"schema_446"}],"pointer":"/paths/~1v1~1auth~1password~1reset~1email~1otp~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiValidateResetPasswordResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiValidateResetPasswordResponse"}}},{"code":"400","schemaId":"schema_444","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}}},{"code":"403","schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}}},{"code":"404","schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/reset/email/otp/validate"},{"label":"Start reset by SMS OTP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/sendresetpasswordsmsotp","routeSlug":"/openapi/user/passwords.openapi/other/sendresetpasswordsmsotp","metadata":{"seo":{"title":"Start reset by SMS OTP","description":"Starts a password reset flow by sending an SMS OTP. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendResetPasswordSMSOTP","name":"Start reset by SMS OTP","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1reset~1sms~1otp/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start reset by SMS OTP","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":"Starts a password reset flow by sending an SMS OTP. "},"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:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordSmsOtpInput"}},"schemaId":"components/schemas/ApiSendResetPasswordSmsOtpInput","pointer":"/paths/~1v1~1auth~1password~1reset~1sms~1otp/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/reset/sms/otp","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordSmsOtpInput"}},"responseCodes":["200","403","404","503"],"pointer":"/v1/auth/password/reset/sms/otp","href":"other/sendresetpasswordsmsotp","openApiOperationId":"sendResetPasswordSMSOTP","summary":"Start reset by SMS OTP"},"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/ApiSendResetPasswordSmsOtpInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordSmsOtpInput"}},"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":"components/schemas/ApiSendResetPasswordSmsOtpResponse"}},"schemaId":"components/schemas/ApiSendResetPasswordSmsOtpResponse"},{"code":"403","description":"When the phone number of the user is not verified, a forbidden error will be returned","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}},"schemaId":"schema_447"},{"code":"404","description":"When there is no user with the requested phone number as primary phone number in the tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_448"}},"schemaId":"schema_448"},{"code":"503","description":"Error occurred while sending SMS","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440"}],"pointer":"/paths/~1v1~1auth~1password~1reset~1sms~1otp/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiSendResetPasswordSmsOtpResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSendResetPasswordSmsOtpResponse"}}},{"code":"403","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"code":"404","schemaId":"schema_448","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_448"}}},{"code":"503","schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/reset/sms/otp"},{"label":"Validate reset SMS OTP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/validateresetpasswordsmsotp","routeSlug":"/openapi/user/passwords.openapi/other/validateresetpasswordsmsotp","metadata":{"seo":{"title":"Validate reset SMS OTP","description":"Validate a reset password OTP. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateResetPasswordSMSOTP","name":"Validate reset SMS OTP","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1reset~1sms~1otp~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate reset SMS OTP","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":"Validate a reset password OTP. "},"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:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiVerifyResetSmsOtpInput"}},"schemaId":"components/schemas/ApiVerifyResetSmsOtpInput","pointer":"/paths/~1v1~1auth~1password~1reset~1sms~1otp~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/reset/sms/otp/validate","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiVerifyResetSmsOtpInput"}},"responseCodes":["200","400","403","404"],"pointer":"/v1/auth/password/reset/sms/otp/validate","href":"other/validateresetpasswordsmsotp","openApiOperationId":"validateResetPasswordSMSOTP","summary":"Validate reset SMS OTP"},"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/ApiVerifyResetSmsOtpInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiVerifyResetSmsOtpInput"}},"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":"components/schemas/ApiValidateResetPasswordResponse"}},"schemaId":"components/schemas/ApiValidateResetPasswordResponse"},{"code":"400","description":"Invalid phone number, email, username or passcode","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}},"schemaId":"schema_449"},{"code":"403","description":"When the provided OTP is expired or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445"},{"code":"404","description":"When the requested user does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}},"schemaId":"schema_446"}],"pointer":"/paths/~1v1~1auth~1password~1reset~1sms~1otp~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiValidateResetPasswordResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiValidateResetPasswordResponse"}}},{"code":"400","schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}}},{"code":"403","schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}}},{"code":"404","schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/reset/sms/otp/validate"},{"label":"Start reset by password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/validateoldpassword","routeSlug":"/openapi/user/passwords.openapi/other/validateoldpassword","metadata":{"seo":{"title":"Start reset by password","description":"Validates the current password and returns a reset token, which enables changing the user`s password"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateOldPassword","name":"Start reset by password","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1reset~1password~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start reset by password","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":"Validates the current password and returns a reset token, which enables changing the user`s password"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiResetPasswordByOldPasswordInput"}},"schemaId":"components/schemas/ApiResetPasswordByOldPasswordInput","pointer":"/paths/~1v1~1auth~1password~1reset~1password~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/reset/password/validate","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiResetPasswordByOldPasswordInput"}},"responseCodes":["200","403","404"],"pointer":"/v1/auth/password/reset/password/validate","href":"other/validateoldpassword","openApiOperationId":"validateOldPassword","summary":"Start reset by password"},"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/ApiResetPasswordByOldPasswordInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiResetPasswordByOldPasswordInput"}},"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":"components/schemas/ApiValidateResetPasswordResponse"}},"schemaId":"components/schemas/ApiValidateResetPasswordResponse"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the provided username, password or client_id are incorrect"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_450"}},"schemaId":"schema_450"},{"code":"404","description":"Client does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}},"schemaId":"schema_451"}],"pointer":"/paths/~1v1~1auth~1password~1reset~1password~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiValidateResetPasswordResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiValidateResetPasswordResponse"}}},{"code":"403","schemaId":"schema_450","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_450"}}},{"code":"404","schemaId":"schema_451","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/reset/password/validate"},{"label":"Reset password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/resetpassword","routeSlug":"/openapi/user/passwords.openapi/other/resetpassword","metadata":{"seo":{"title":"Reset password","description":"Resets a user's password"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resetPassword","name":"Reset password","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1reset/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resets a user's password"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiResetPasswordInput"}},"schemaId":"components/schemas/ApiResetPasswordInput","pointer":"/paths/~1v1~1auth~1password~1reset/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/reset","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiResetPasswordInput"}},"responseCodes":["200","400","403"],"pointer":"/v1/auth/password/reset","href":"other/resetpassword","openApiOperationId":"resetPassword","summary":"Reset password"},"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/ApiResetPasswordInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiResetPasswordInput"}},"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":"components/schemas/ApiResetPasswordResponse"}},"schemaId":"components/schemas/ApiResetPasswordResponse"},{"code":"400","description":"When the new password doesn't meet the password complexity requirements","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"},{"code":"403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenHttpError"}},"schemaId":"components/schemas/ForbiddenHttpError"}],"pointer":"/paths/~1v1~1auth~1password~1reset/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResetPasswordResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResetPasswordResponse"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}},{"code":"403","schemaId":"components/schemas/ForbiddenHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ForbiddenHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/reset"},{"label":"Validate password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/validatepassword","routeSlug":"/openapi/user/passwords.openapi/other/validatepassword","metadata":{"seo":{"title":"Validate password","description":"Validates a new password according to the requesting application's password policy. The validation includes checking the password complexity (such as minimum length and character requirements) and password history (i.e., that the same password wasn't used too recently). This can be used before updating a user's password to first check that the password they chose is valid and if not, provide feedback to the user. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validatePassword","name":"Validate password","isWebhook":false,"pointer":"/paths/~1v1~1auth~1password~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate password","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":"Validates a new password according to the requesting application's password policy. The validation includes checking the password complexity (such as minimum length and character requirements) and password history (i.e., that the same password wasn't used too recently). This can be used before updating a user's password to first check that the password they chose is valid and if not, provide feedback to the user. "},"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:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth:execute"},"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":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiValidatePasswordInput"}},"schemaId":"components/schemas/ApiValidatePasswordInput","pointer":"/paths/~1v1~1auth~1password~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/password/validate","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiValidatePasswordInput"}},"responseCodes":["200","400","404"],"pointer":"/v1/auth/password/validate","href":"other/validatepassword","openApiOperationId":"validatePassword","summary":"Validate password"},"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/ApiValidatePasswordInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiValidatePasswordInput"}},"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":"components/schemas/ApiValidatePasswordResponse"}},"schemaId":"components/schemas/ApiValidatePasswordResponse"},{"code":"400","description":"Password validation errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}},"schemaId":"schema_452"},{"code":"404","description":"Client does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}},"schemaId":"schema_451"}],"pointer":"/paths/~1v1~1auth~1password~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiValidatePasswordResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiValidatePasswordResponse"}}},{"code":"400","schemaId":"schema_452","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}}},{"code":"404","schemaId":"schema_451","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/password/validate"},{"label":"Logout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/logout","routeSlug":"/openapi/user/passwords.openapi/other/logout","metadata":{"seo":{"title":"Logout","description":"Logout the user from a specific session. The user and session are derived from the access token used to authorize the request (which was issued based on the authentication that created the session)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"logout","name":"Logout","isWebhook":false,"pointer":"/paths/~1v1~1auth~1logout/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Logout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Logout the user from a specific session. The user and session are derived from the access token used to authorize the request (which was issued based on the authentication that created the session)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserAccessToken","scopes":[],"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"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/logout","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/auth/logout","href":"other/logout","openApiOperationId":"logout","summary":"Logout"},"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","description":"Sessions deleted Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiLogoutResponse"}},"schemaId":"components/schemas/ApiLogoutResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestException"}},"schemaId":"components/schemas/BadRequestException"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenHttpError"}},"schemaId":"components/schemas/InvalidTokenHttpError"}],"pointer":"/paths/~1v1~1auth~1logout/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiLogoutResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiLogoutResponse"}}},{"code":"400","schemaId":"components/schemas/BadRequestException","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestException"}}},{"code":"401","schemaId":"components/schemas/InvalidTokenHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/logout"},{"label":"Exchange code for token","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/passwords.openapi/other/tokenexchange","routeSlug":"/openapi/user/passwords.openapi/other/tokenexchange","metadata":{"seo":{"title":"Exchange code for token","description":"Retrieve ID and access tokens. This API is used to retrieve ID and access tokens using the code that was returned in the redirect URI as a query parameter (for example, when the user clicks a magic link). It may also create a new user if create_new_user was set to true in the send request and no user exists for the email address or phone number (depending on the flow)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokenExchange","name":"Exchange code for token","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange code for token","isWebhook":false,"deprecated":true,"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":"Retrieve ID and access tokens. This API is used to retrieve ID and access tokens using the code that was returned in the redirect URI as a query parameter (for example, when the user clicks a magic link). It may also create a new user if create_new_user was set to true in the send request and no user exists for the email address or phone number (depending on the flow)."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiTokenExchangeRequestInput"}},"schemaId":"components/schemas/ApiTokenExchangeRequestInput","pointer":"/paths/~1v1~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/token","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":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiTokenExchangeRequestInput"}},"responseCodes":["200","400"],"pointer":"/v1/token","href":"other/tokenexchange","openApiOperationId":"tokenExchange","summary":"Exchange code for token"},"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/ApiTokenExchangeRequestInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiTokenExchangeRequestInput"}},"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":"components/schemas/ApiTokenExchangeResponse"}},"schemaId":"components/schemas/ApiTokenExchangeResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"}],"pointer":"/paths/~1v1~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiTokenExchangeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiTokenExchangeResponse"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/token"}],"store":{"schemaStore":{"components/schemas/ApiLogoutResponse":{"id":"components/schemas/ApiLogoutResponse","kind":"json-schema","title":"ApiLogoutResponse","data":{"type":"object","properties":{"sessions_count":{"type":"number","description":"Number of logged out sessions"}},"required":["sessions_count"]}},"components/schemas/BadRequestException":{"id":"components/schemas/BadRequestException","kind":"json-schema","title":"BadRequestException","data":{"type":"object","properties":{}}},"components/schemas/InvalidTokenHttpError":{"id":"components/schemas/InvalidTokenHttpError","kind":"json-schema","title":"InvalidTokenHttpError","data":{"type":"object","properties":{"message":{"type":"string","example":"Invalid token"},"error_code":{"type":"number","example":401}},"required":["message","error_code"]}},"components/schemas/ApiTokenExchangeRequestInput":{"id":"components/schemas/ApiTokenExchangeRequestInput","kind":"json-schema","title":"ApiTokenExchangeRequestInput","data":{"type":"object","properties":{"code":{"type":"string","description":"Authorization code returned in the redirect URI as a query parameter upon successful authentication","example":"GZxLFKTDCnlANVTxNvaWz7AIGPpXqZYSXdAwjiWRuOH"},"client_id":{"type":"string","description":"Client ID of the application requesting the token","example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV","maxLength":50},"client_secret":{"type":"string","description":"Client Secret of the application requesting the token","example":"FzxvdDMbvxnc45sdfb789XCVGEW6usazxcvbw3KPsb23","maxLength":50}},"required":["code","client_id","client_secret"]}},"components/schemas/ApiTokenExchangeResponse":{"id":"components/schemas/ApiTokenExchangeResponse","kind":"json-schema","title":"ApiTokenExchangeResponse","data":{"type":"object","properties":{"id_token":{"type":"string"},"access_token":{"type":"string"},"refresh_token":{"type":"string"},"is_user_created":{"type":"boolean","description":"Indicates if this is a new user or not"}},"required":["id_token","access_token","refresh_token","is_user_created"]}},"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/ApiSendResetPasswordEmailLinkInput":{"id":"components/schemas/ApiSendResetPasswordEmailLinkInput","kind":"json-schema","title":"ApiSendResetPasswordEmailLinkInput","data":{"type":"object","properties":{"prev_reset_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reset token that contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mfa_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should be passed when initiating a second factor authentication, in case MFA is required for password reset flows."},"children":[]}]}]}]},"ignore_mfa":{"type":"boolean","description":"Allows resetting the password without MFA in case MFA is required for password reset flows"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's primary email address. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"username":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username to send the magic link to. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"redirect_uri":{"type":"string","example":"https://www.example.com/reset-password","description":"URI where the email link will redirect to. This is the server GET endpoint used to call the password reset endpoint, and should accept \"code\" as a query parameter. This URI must also be configured as an allowed redirect URI in the Transmit Admin Portal."},"email_content":{"description":"Texts, logo and color to render email template with","allOf":[{"$ref":"#/components/schemas/EmailContentAttributes"}]}},"required":["redirect_uri"]}},"components/schemas/ApiSendResetPasswordEmailResponse":{"id":"components/schemas/ApiSendResetPasswordEmailResponse","kind":"json-schema","title":"ApiSendResetPasswordEmailResponse","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"Reset password email sent"}},"required":["message"]}},"components/schemas/ApiGenerateResetPasswordLinkInput":{"id":"components/schemas/ApiGenerateResetPasswordLinkInput","kind":"json-schema","title":"ApiGenerateResetPasswordLinkInput","data":{"type":"object","properties":{"prev_reset_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reset token that contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mfa_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should be passed when initiating a second factor authentication, in case MFA is required for password reset flows."},"children":[]}]}]}]},"ignore_mfa":{"type":"boolean","description":"Allows resetting the password without MFA in case MFA is required for password reset flows"},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's primary email address. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"username":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The username to send the magic link to. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"redirect_uri":{"type":"string","example":"https://www.example.com/reset-password","description":"URI where the email link will redirect to. This is the server GET endpoint used to call the password reset endpoint, and should accept \"code\" as a query parameter. This URI must also be configured as an allowed redirect URI in the Transmit Admin Portal."}},"required":["redirect_uri"]}},"components/schemas/ApiGenerateResetPasswordLinkResponse":{"id":"components/schemas/ApiGenerateResetPasswordLinkResponse","kind":"json-schema","title":"ApiGenerateResetPasswordLinkResponse","data":{"type":"object","properties":{"reset_link":{"type":"string","readOnly":true,"example":"Reset password magic link"}},"required":["reset_link"]}},"components/schemas/ApiSendResetPasswordEmailOtpInput":{"id":"components/schemas/ApiSendResetPasswordEmailOtpInput","kind":"json-schema","title":"ApiSendResetPasswordEmailOtpInput","data":{"type":"object","properties":{"prev_reset_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reset token that contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mfa_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should be passed when initiating a second factor authentication, in case MFA is required for password reset flows."},"children":[]}]}]}]},"ignore_mfa":{"type":"boolean","description":"Allows resetting the password without MFA in case MFA is required for password reset flows"},"email":{"type":"string","description":"The user's primary email address"},"email_content":{"description":"Texts, logo and color to render email template with","allOf":[{"$ref":"#/components/schemas/EmailContentAttributes"}]}},"required":["email"]}},"components/schemas/ApiSendResetPasswordEmailOtpResponse":{"id":"components/schemas/ApiSendResetPasswordEmailOtpResponse","kind":"json-schema","title":"ApiSendResetPasswordEmailOtpResponse","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"Email Sent"}},"required":["message"]}},"components/schemas/ApiVerifyResetEmailOtpInput":{"id":"components/schemas/ApiVerifyResetEmailOtpInput","kind":"json-schema","title":"ApiVerifyResetEmailOtpInput","data":{"type":"object","properties":{"email":{"type":"string","description":"Email address that the OTP was sent to"},"passcode":{"type":"string","description":"OTP to validate"}},"required":["email","passcode"]}},"components/schemas/ApiValidateResetPasswordResponse":{"id":"components/schemas/ApiValidateResetPasswordResponse","kind":"json-schema","title":"ApiValidateResetPasswordResponse","data":{"type":"object","properties":{"result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reset token to be used when sending a reset request ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/auth/password/reset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}},"required":["result"]}},"components/schemas/ApiSendResetPasswordSmsOtpInput":{"id":"components/schemas/ApiSendResetPasswordSmsOtpInput","kind":"json-schema","title":"ApiSendResetPasswordSmsOtpInput","data":{"type":"object","properties":{"prev_reset_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reset token that contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mfa_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should be passed when initiating a second factor authentication, in case MFA is required for password reset flows."},"children":[]}]}]}]},"ignore_mfa":{"type":"boolean","description":"Allows resetting the password without MFA in case MFA is required for password reset flows"},"phone_number":{"type":"string","example":"+16175551212","description":"Phone number to send the SMS to, specified in E.164 format"}},"required":["phone_number"]}},"components/schemas/ApiSendResetPasswordSmsOtpResponse":{"id":"components/schemas/ApiSendResetPasswordSmsOtpResponse","kind":"json-schema","title":"ApiSendResetPasswordSmsOtpResponse","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"SMS Sent"}},"required":["message"]}},"components/schemas/ApiVerifyResetSmsOtpInput":{"id":"components/schemas/ApiVerifyResetSmsOtpInput","kind":"json-schema","title":"ApiVerifyResetSmsOtpInput","data":{"type":"object","properties":{"phone_number":{"type":"string","description":"Phone number that the SMS OTP was sent to"},"passcode":{"type":"string","description":"OTP to validate"}},"required":["phone_number","passcode"]}},"components/schemas/ApiResetPasswordByOldPasswordInput":{"id":"components/schemas/ApiResetPasswordByOldPasswordInput","kind":"json-schema","title":"ApiResetPasswordByOldPasswordInput","data":{"type":"object","properties":{"prev_reset_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reset token that contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mfa_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Should be passed when initiating a second factor authentication, in case MFA is required for password reset flows."},"children":[]}]}]}]},"username":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's username. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's primary email address. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"phone_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's primary phone number. Pass only one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"password":{"type":"string","description":"The user's current password"},"client_id":{"type":"string"}},"required":["password","client_id"]}},"components/schemas/ApiPasswordLoginInput":{"id":"components/schemas/ApiPasswordLoginInput","kind":"json-schema","title":"ApiPasswordLoginInput","data":{"type":"object","properties":{"username":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's username. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's primary email address. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"phone_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's primary phone number. Pass only one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but not both."},"children":[]}]}]}]},"identifier_type":{"type":"string","description":"Type of user identifier used for login"},"identifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User identifier, which may correspond to the user's email, phone number, username, or user ID. The type of identifier should be specified as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifier_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"password":{"type":"string","description":"The user's password"},"client_id":{"type":"string","description":"Client ID of the application requesting authentication, retrieved from the Transmit Admin Portal","example":"c35ab2a.xVShlOVGsUMh3Cqk73K1O.transmit"},"redirect_uri":{"type":"string","description":"URI to redirect to upon completion of the IDP flow. This is the server GET endpoint used to call the token endpoint, and should accept \"code\" as a query parameter. This URI must also be configured as an allowed redirect URI in the Transmit Admin Portal.","example":"https://domain.com/verify"},"resource":{"type":"string","description":"Resource URI the login is attempting to access."},"require_mfa":{"type":"boolean","example":true,"default":false,"description":"Require multi-factor authentication for this authentication request."},"claims":{"type":"object","example":{"id_token":{"roles":null}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to request additional claims in the ID token, such as roles, permissions, and other user profile data. The structure is per the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OIDC Standard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For supported claims and how to request custom claims, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.transmitsecurity.com/openapi/id_token_reference/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID Token Reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"org_id":{"type":"string","description":"Organization ID, used for member login in B2B scenarios"}},"required":["password","client_id","redirect_uri"]}},"components/schemas/ApiResetPasswordRequiredErrorResponse":{"id":"components/schemas/ApiResetPasswordRequiredErrorResponse","kind":"json-schema","title":"ApiResetPasswordRequiredErrorResponse","data":{"type":"object","properties":{"message":{"type":"string","enum":["password_expired","temporary_password","temporary_password_expired"],"description":"Reason the password reset is required"},"error_code":{"type":"number","example":403},"reset_token":{"type":"string","readOnly":true,"description":"Reset token needed to authorize the password reset, if a password reset is required"},"ts_error_code":{"type":"string","enum":["system_invalid_input","system_unauthorized","system_conflict","system_forbidden","system_unexpected_error","system_service_unavailable","app_not_exist","client_not_exist","client_id_mismatch","client_not_authorized","client_max_secrets_exceeded","client_cannot_revoke_last_secret","client_secret_not_found","client_authority_max_iats_exceeded","user_already_exists","user_not_found","user_not_active","user_email_address_missing","user_phone_number_missing","user_email_is_not_verified","user_phone_number_is_not_verified","user_external_user_id_missing","user_unknown_identifier_type","user_unknown_identity_provider_source_type","group_not_found","session_not_found","session_account_mismatch","session_invalid","session_account_id_not_found","session_grant_not_found","session_granted_account_mismatch","session_grant_id_mismatch","auth_login_preferences_missing","auth_invalid_credentials","auth_locked","auth_not_found","authenticator_not_found","auth_not_active","auth_not_registered","auth_registration_failed","auth_max_authenticators_count_exceeded","auth_otp_passcode_expired","auth_otp_invalid_request_id","auth_reset_otp_send_limit_reached","auth_password_expired","auth_password_temporary","auth_password_recently_used","auth_password_policy_disabled","auth_password_weak","auth_password_breached","auth_password_requirements_not_met","auth_password_already_configured","auth_password_incomplete_credentials","auth_password_invalid_reset_token","auth_totp_transaction_not_initialized_or_expired","auth_totp_invalid_token","auth_totp_already_registered","auth_totp_max_authenticators_attempt_limit_exceeded","auth_webauthn_invalid_origin_error","auth_webauthn_origin_not_allowed","auth_webauthn_invalid_webauthn_config","auth_webauthn_invalid_encoded_result","auth_webauthn_invalid_session","auth_webauthn_invalid_register_cred_token","auth_webauthn_credential_name_already_exists","auth_invalid_attestation","auth_invalid_key_type","auth_invalid_key_encoding","auth_key_not_found","auth_invalid_signature","auth_invalid_binding_message","auth_invalid_request_context","auth_invalid_channel","auth_device_key_not_found","auth_push_notification_failed","auth_authentication_request_not_found","auth_authentication_request_expired","auth_authentication_request_denied","auth_authorization_request_pending","auth_backchannel_request_not_found","auth_backchannel_request_expired","auth_backchannel_request_already_completed","auth_invalid_redirect_uri","auth_challenge_mismatch","auth_request_not_found","auth_face_already_registered","auth_invalid_idv_session","auth_face_selfie_failed_on_liveness_check","auth_revoke_failed","external_provider_error","external_provider_configuration_error","role_not_found","role_group_not_found","organization_not_found","sso_not_exist","webhook_not_found","device_not_found","device_limit_exceeded"],"description":"Internal error code","example":"auth_password_expired"}},"required":["message","error_code","reset_token"]}},"components/schemas/ApiPasswordLoginResponse":{"id":"components/schemas/ApiPasswordLoginResponse","kind":"json-schema","title":"ApiPasswordLoginResponse","data":{"type":"object","properties":{"url":{"type":"string","readOnly":true,"description":"URL to start the authentication flow. This is only returned if password reset is not required."}}}},"components/schemas/ApiResetPasswordInput":{"id":"components/schemas/ApiResetPasswordInput","kind":"json-schema","title":"ApiResetPasswordInput","data":{"type":"object","properties":{"reset_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" generated from the password login call or by initiating a password reset flow"},"children":[]}]}]}]},"new_password":{"type":"string","description":"The new password"},"redirect_uri":{"type":"string","description":"Redirect URI for redirecting the client after a successful password change"},"resource":{"type":"string","description":"Resource to access after successful password change"},"require_mfa":{"type":"boolean","example":true,"default":false,"description":"Require multi-factor authentication for this authentication request."}},"required":["reset_token","new_password"]}},"components/schemas/ApiResetPasswordResponse":{"id":"components/schemas/ApiResetPasswordResponse","kind":"json-schema","title":"ApiResetPasswordResponse","data":{"type":"object","properties":{"message":{"type":"string","readOnly":true,"example":"Password changed successfully"},"url":{"type":"string","readOnly":true,"description":"URL to start the authorization flow with the new password"},"email":{"type":"string","readOnly":true,"description":"User email to which the notification will be sent"}},"required":["message","url","email"]}},"components/schemas/ForbiddenHttpError":{"id":"components/schemas/ForbiddenHttpError","kind":"json-schema","title":"ForbiddenHttpError","data":{"type":"object","properties":{"message":{"type":"string"},"error_code":{"type":"number","example":403}},"required":["message","error_code"]}},"components/schemas/ApiValidatePasswordInput":{"id":"components/schemas/ApiValidatePasswordInput","kind":"json-schema","title":"ApiValidatePasswordInput","data":{"type":"object","properties":{"email":{"type":"string","description":"Email of the user who provided the password. Used to identify the user to check password history."},"phone_number":{"type":"string","description":"Phone number of the user who provided the password. Used to identify the user to check password history."},"username":{"type":"string","description":"Username of the user who provided the password. Used to identify the user to check password history."},"password":{"type":"string","description":"Password to validate"}},"required":["password"]}},"components/schemas/ApiValidatePasswordResponse":{"id":"components/schemas/ApiValidatePasswordResponse","kind":"json-schema","title":"ApiValidatePasswordResponse","data":{"type":"object","properties":{"result":{"description":"Result of password validation","allOf":[{"$ref":"#/components/schemas/ApiValidatePasswordResult"}]}},"required":["result"]}},"components/schemas/EmailContentAttributes":{"id":"components/schemas/EmailContentAttributes","kind":"json-schema","title":"EmailContentAttributes","data":{"type":"object","properties":{"subject":{"type":"string","description":"The subject of the email"},"primaryColor":{"type":"string","example":"#6981FF","description":"Primary color of the email, specified as a Hex color"},"base64logo":{"type":"string","description":"Base64 encoded image for email logo. Must be raw base64 of a PNG, JPEG, GIF or WebP image, without a data URI prefix, such as 'data:image/png;base64,'. The string length must be less than or equal to 60000 characters."},"headerText":{"type":"string","description":"The header of the email"},"bodyText":{"type":"string","description":"The body of the email"},"linkText":{"type":"string","description":"The text of the link button in the email"},"infoText":{"type":"string","description":"Any extra information in the email"},"footerText":{"type":"string","example":"If you didn't request this email, you can safely ignore it.","description":"The footer of the email"},"senderName":{"type":"string","description":"Name of the sender of the email"}},"required":["subject"]}},"components/schemas/ApiValidatePasswordResult":{"id":"components/schemas/ApiValidatePasswordResult","kind":"json-schema","title":"ApiValidatePasswordResult","data":{"type":"object","properties":{"valid_password":{"type":"boolean","description":"Boolean describing if the password is valid for this app and/or user"},"errors":{"description":"List of issues found with the given password, if validation fails","type":"array","items":{"$ref":"#/components/schemas/ApiPasswordValidationError"}}},"required":["valid_password","errors"]}},"components/schemas/ApiPasswordValidationError":{"id":"components/schemas/ApiPasswordValidationError","kind":"json-schema","title":"ApiPasswordValidationError","data":{"type":"object","properties":{"code":{"type":"string","description":"Validation issue with given password"},"message":{"type":"string","description":"Description of the specific problem with the given password"}},"required":["code","message"]}},"schema_436":{"kind":"json-schema","data":{"title":"ApiOkResponse-login","type":"object","required":["result"],"description":"The URL to start the authorization flow","properties":{"result":{"$ref":"#/components/schemas/ApiPasswordLoginResponse"}}},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_invalid_redirect_uri"]},"message":{"type":"string"}}},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["system_forbidden"]},"message":{"type":"string"}}},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["client_not_exist","user_not_found","user_email_address_missing"]},"message":{"type":"string"}}},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["system_service_unavailable"]},"message":{"type":"string"}}},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["client_not_exist","user_not_found"]},"message":{"type":"string"}}},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["system_forbidden","auth_login_preferences_missing","auth_password_invalid_reset_token","user_not_active"]},"message":{"type":"string"}}},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["app_not_exist","user_email_address_missing","user_phone_number_missing","user_not_found"]},"message":{"type":"string"}}},"id":"schema_443"},"schema_444":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_invalid_credentials","user_unknown_identifier_type"]},"message":{"type":"string"}}},"id":"schema_444"},"schema_445":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_otp_invalid_request_id","auth_login_preferences_missing","auth_locked","auth_invalid_credentials"]},"message":{"type":"string"}}},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["client_not_exist","app_not_exist"]},"message":{"type":"string"}}},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["system_forbidden","auth_password_invalid_reset_token"]},"message":{"type":"string"}}},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["app_not_exist","user_phone_number_missing"]},"message":{"type":"string"}}},"id":"schema_448"},"schema_449":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_invalid_credentials","auth_otp_passcode_expired"]},"message":{"type":"string"}}},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_locked","auth_password_invalid_reset_token","auth_invalid_credentials"]},"message":{"type":"string"}}},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["client_not_exist"]},"message":{"type":"string"}}},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["system_invalid_input","auth_password_recently_used","auth_password_policy_disabled","auth_not_active","auth_password_weak","auth_password_breached"]},"message":{"type":"string"}}},"id":"schema_452"}},"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/passwords.openapi.json?download"},{"url":"/_bundle/openapi/user/passwords.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Passwords","description":"Login users using passwords. This implements a frontend integration for password authentication, where passwords are handled only by the client. If the password credentials are valid, the client can obtain an authorization code that your app can exchange in the backend for user tokens."}},"baseSlug":"/openapi/user/passwords.openapi","routesMapping":{}}