{"items":[{"type":"link","label":"User Authenticators","link":"/openapi/user/authenticators.openapi","routeSlug":"/openapi/user/authenticators.openapi","content":{"contentType":"overview","meta":{"name":"User Authenticators"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"authenticators.openapi.json","url":"/_bundle/openapi/user/authenticators.openapi.json?download"},{"kind":"download","label":"authenticators.openapi.yaml","url":"/_bundle/openapi/user/authenticators.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":"User Authenticators","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Manage user authenticators, such as WebAuthn credentials, TOTP authenticators, and more. These APIs allow you to view and manage the authenticators that were registered for a given user."}],"sectionId":"/openapi/user/authenticators.openapi"}],"sectionId":"/openapi/user/authenticators.openapi"}]}]}},{"label":"Get authenticators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/authenticators.openapi/other/userauthenticators","routeSlug":"/openapi/user/authenticators.openapi/other/userauthenticators","metadata":{"seo":{"title":"Get authenticators","description":"Retrieves all authenticators for a specific user. Required permissions: organizations:read, orgs:read, users:read, apps:read, [appId]:read, authenticators:read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userAuthenticators","name":"Get authenticators","isWebhook":false,"pointer":"/paths/~1v1~1users~1{userId}~1authenticators/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get authenticators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves all authenticators for a specific 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":"organizations:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticators:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_328","description":"ID of the user","required":true}],"pointer":"/paths/~1v1~1users~1{userId}~1authenticators/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/users/{userId}/authenticators","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_328"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/users/{userId}/authenticators","href":"other/userauthenticators","openApiOperationId":"userAuthenticators","summary":"Get authenticators"},"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":"User authenticators object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGetUserAuthenticatorsResponse"}},"schemaId":"components/schemas/ApiGetUserAuthenticatorsResponse"}],"pointer":"/paths/~1v1~1users~1{userId}~1authenticators/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGetUserAuthenticatorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGetUserAuthenticatorsResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v1/users/{userId}/authenticators"},{"label":"Unlock authenticator","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/authenticators.openapi/other/unlockuserauthenticator","routeSlug":"/openapi/user/authenticators.openapi/other/unlockuserauthenticator","metadata":{"seo":{"title":"Unlock authenticator","description":"Unlocks a user's authenticator by clearing attempts data. Use optional unlock_type to limit the unlock operation to a specific lock type, such as manual (via Admin Portal or /lock) or automatic (via lockout policy). Note that TOTP authenticators cannot be unlocked by an authenticator id, use unlock by type instead. Required permissions: apps:edit, [appId]:edit, authenticators:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlockUserAuthenticator","name":"Unlock authenticator","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}~1unlock/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlock authenticator","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":"Unlocks a user's authenticator by clearing attempts data. Use optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unlock_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to limit the unlock operation to a specific lock type, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (via Admin Portal or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/lock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (via lockout policy). Note that TOTP authenticators cannot be unlocked by an authenticator id, use unlock by type instead. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticators:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_328","description":"ID of the user","required":true},{"name":"authenticator_id","in":"path","schemaId":"schema_328","description":"ID of the authenticator to unlock.","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}~1unlock/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnlockAuthenticatorBodyDto"}},"schemaId":"components/schemas/UnlockAuthenticatorBodyDto","pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}~1unlock/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/authenticators/{authenticator_id}/unlock","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_328"},{"name":"authenticator_id","in":"path","required":true,"schemaId":"schema_328"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UnlockAuthenticatorBodyDto"}},"responseCodes":["204"],"pointer":"/v1/users/{user_id}/authenticators/{authenticator_id}/unlock","href":"other/unlockuserauthenticator","openApiOperationId":"unlockUserAuthenticator","summary":"Unlock authenticator"},"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/UnlockAuthenticatorBodyDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnlockAuthenticatorBodyDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"User Unlocked"}],"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}~1unlock/post/responses"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}/authenticators/{authenticator_id}/unlock"},{"label":"Unlock authenticator by type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/authenticators.openapi/other/unlockuserauthenticatorbytype","routeSlug":"/openapi/user/authenticators.openapi/other/unlockuserauthenticatorbytype","metadata":{"seo":{"title":"Unlock authenticator by type","description":"Unlocks a user's authenticator by type. Use optional unlock_type to limit the unlock operation to a specific lock type, such as manual (via Admin Portal or /lock) or automatic (via lockout policy). Note that TOTP authenticators locked due to the automatic lockout policy cannot be unlocked. Required permissions: apps:edit, [appId]:edit, authenticators:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlockUserAuthenticatorByType","name":"Unlock authenticator by type","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1types~1{authenticator_type}~1unlock/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlock authenticator by type","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":"Unlocks a user's authenticator by type. Use optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unlock_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to limit the unlock operation to a specific lock type, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (via Admin Portal or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/lock"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (via lockout policy). Note that TOTP authenticators locked due to the automatic lockout policy cannot be unlocked. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticators:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_328","description":"ID of the user","required":true},{"name":"authenticator_type","in":"path","schemaId":"schema_329","description":"Authenticator type to unlock.","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1types~1{authenticator_type}~1unlock/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnlockAuthenticatorBodyDto"}},"schemaId":"components/schemas/UnlockAuthenticatorBodyDto","pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1types~1{authenticator_type}~1unlock/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/authenticators/types/{authenticator_type}/unlock","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_328"},{"name":"authenticator_type","in":"path","required":true,"schemaId":"schema_329"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UnlockAuthenticatorBodyDto"}},"responseCodes":["204"],"pointer":"/v1/users/{user_id}/authenticators/types/{authenticator_type}/unlock","href":"other/unlockuserauthenticatorbytype","openApiOperationId":"unlockUserAuthenticatorByType","summary":"Unlock authenticator by type"},"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/UnlockAuthenticatorBodyDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnlockAuthenticatorBodyDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"User Unlocked"}],"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1types~1{authenticator_type}~1unlock/post/responses"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}/authenticators/types/{authenticator_type}/unlock"},{"label":"Lock authenticator","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/authenticators.openapi/other/lockuserauthenticator","routeSlug":"/openapi/user/authenticators.openapi/other/lockuserauthenticator","metadata":{"seo":{"title":"Lock authenticator","description":"Locks a user's authenticator by setting status to Deactivated. Required permissions: apps:edit, [appId]:edit, authenticators:edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lockUserAuthenticator","name":"Lock authenticator","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}~1lock/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lock authenticator","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":"Locks a user's authenticator by setting status to Deactivated. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticators:edit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_328","description":"ID of the user","required":true},{"name":"authenticator_id","in":"path","schemaId":"schema_328","description":"Authenticator ID to lock.","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}~1lock/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LockAuthenticatorInputParams"}},"schemaId":"components/schemas/LockAuthenticatorInputParams","pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}~1lock/post/requestBody","description":"Optional body with reason"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/users/{user_id}/authenticators/{authenticator_id}/lock","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_328"},{"name":"authenticator_id","in":"path","required":true,"schemaId":"schema_328"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LockAuthenticatorInputParams"}},"responseCodes":["204"],"pointer":"/v1/users/{user_id}/authenticators/{authenticator_id}/lock","href":"other/lockuserauthenticator","openApiOperationId":"lockUserAuthenticator","summary":"Lock authenticator"},"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/LockAuthenticatorInputParams","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LockAuthenticatorInputParams"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Authenticator Locked"}],"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}~1lock/post/responses"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}/authenticators/{authenticator_id}/lock"},{"label":"Delete authenticator","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/authenticators.openapi/other/deleteuserauthenticator","routeSlug":"/openapi/user/authenticators.openapi/other/deleteuserauthenticator","metadata":{"seo":{"title":"Delete authenticator","description":"Deletes a user's authenticator by ID. Required permissions: apps:delete, [appId]:delete, authenticators:delete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUserAuthenticator","name":"Delete authenticator","isWebhook":false,"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete authenticator","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":"Deletes a user's authenticator by ID. "},"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:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[appId]:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticators:delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientAccessToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_328","description":"ID of the user","required":true},{"name":"authenticator_id","in":"path","schemaId":"schema_328","description":"ID of the authenticator to delete.","required":true}],"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/users/{user_id}/authenticators/{authenticator_id}","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_328"},{"name":"authenticator_id","in":"path","required":true,"schemaId":"schema_328"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204"],"pointer":"/v1/users/{user_id}/authenticators/{authenticator_id}","href":"other/deleteuserauthenticator","openApiOperationId":"deleteUserAuthenticator","summary":"Delete authenticator"},"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":"204","description":"Authenticator Deleted"}],"pointer":"/paths/~1v1~1users~1{user_id}~1authenticators~1{authenticator_id}/delete/responses"}],"panels":[]}]},"httpPath":"/v1/users/{user_id}/authenticators/{authenticator_id}"}],"store":{"schemaStore":{"components/schemas/ApiGetUserAuthenticatorsResponse":{"id":"components/schemas/ApiGetUserAuthenticatorsResponse","kind":"json-schema","title":"ApiGetUserAuthenticatorsResponse","data":{"type":"object","properties":{"result":{"description":"List of user authenticators","type":"array","items":{"$ref":"#/components/schemas/ApiUserAuthenticatorOutput"}}},"required":["result"]}},"components/schemas/UnlockAuthenticatorBodyDto":{"id":"components/schemas/UnlockAuthenticatorBodyDto","kind":"json-schema","title":"UnlockAuthenticatorBodyDto","data":{"type":"object","properties":{"unlock_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of lock to clear: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (authenticator locked manually in the Admin Portal or via /lock endpoint) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automatic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (authenticator locked automatically after failed login attempts as defined by the lockout policy)."},"children":[]}]}]}],"enum":["manual","automatic","any"]}}}},"components/schemas/LockAuthenticatorInputParams":{"id":"components/schemas/LockAuthenticatorInputParams","kind":"json-schema","title":"LockAuthenticatorInputParams","data":{"type":"object","properties":{"reason":{"type":"string","description":"Reason for locking"}}}},"components/schemas/ApiUserAuthenticatorOutput":{"id":"components/schemas/ApiUserAuthenticatorOutput","kind":"json-schema","title":"ApiUserAuthenticatorOutput","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the authenticator, autogenerated upon registration"},"type":{"type":"string","description":"The type of the authenticator","enum":["totp","email_magic_link","email_otp","sms_otp","direct_otp","webauthn","password","mobile_biometric","pin_authenticator","google","facebook","apple","line","saml","oidc","face"]},"name":{"type":"string","description":"The name of the authenticator"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the authenticator. An authenticator is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it hasn't yet been used to authenticate, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it's been used at least once. Admins can update the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deactivated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manually block it (either temporarily or permanently) and an authenticator can become "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by the lockout rules defined in its settings."},"children":[]}]}]}],"enum":["Active","Deactivated","Registered","Locked","Deleted"]},"user_id":{"type":"string","description":"The ID of the user this authenticator is associated with"},"status_changed_at":{"format":"date-time","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field last changed, for example when an admin deactivated the authenticator or activated it again. Empty if the status has never changed or changed before this field was added. Updated only when the status change is saved. Status derived at read time, such as a disabled user or suspended device, does not update this field."},"children":[]}]}]}]},"registered_at":{"format":"date-time","type":"string","description":"The date the authenticator was registered. For social login methods, this corresponds to the date it was first used to authenticate. For email/SMS-based ones, it corresponds to the date the email/phone number was added to the user profile."},"last_successful_authentication":{"format":"date-time","type":"string","description":"Date this authenticator was last used to successfully authenticate."},"last_failed_authentication":{"format":"date-time","type":"string","description":"The last failed authentication date. For social login and email/SMS-based methods, this may corresponds to an authentications performed for another app in the tenant."},"last_accessed_app_id":{"type":"string","description":"ID of the last application the authenticator was used to authenticate for","deprecated":true},"app_id":{"type":"string"},"last_accessed_org_id":{"type":"string","description":"ID of the last organization the authenticator was used to authenticate for"},"lockout":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lockout (applicable only when the authenticator’s status is locked)"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/ApiUserAuthenticatorLockout"}]},"registering_device":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The device that was used during registration, including device_id and timestamp."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/RegisteringDevice"}]},"last_used_devices":{"description":"The most recent devices used to authenticate with this authenticator (up to 5, newest first).","maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/LastUsedDevices"}},"extra_data":{"description":"Additional data for the authenticator","oneOf":[{"$ref":"#/components/schemas/ApiEmailMagicLinkExtraData"},{"$ref":"#/components/schemas/ApiEmailOtpExtraData"},{"$ref":"#/components/schemas/ApiSmsOtpExtraData"},{"$ref":"#/components/schemas/ApiTotpExtraData"},{"$ref":"#/components/schemas/ApiGoogleExtraData"},{"$ref":"#/components/schemas/ApiFacebookExtraData"},{"$ref":"#/components/schemas/ApiAppleExtraData"},{"$ref":"#/components/schemas/ApiLineExtraData"},{"$ref":"#/components/schemas/ApiSamlExtraData"},{"$ref":"#/components/schemas/ApiOidcExtraData"},{"$ref":"#/components/schemas/ApiPasswordExtraData"},{"$ref":"#/components/schemas/ApiWebauthnExtraData"},{"$ref":"#/components/schemas/ApiMobileBiometricExtraData"},{"$ref":"#/components/schemas/ApiPinAuthenticatorExtraData"}]}},"required":["id","type","status","registered_at"]}},"components/schemas/LastUsedDevices":{"id":"components/schemas/LastUsedDevices","kind":"json-schema","title":"LastUsedDevices","data":{"type":"object","properties":{"device_id":{"type":"string","description":"The device identifier"},"device_ownership":{"type":"string","description":"Device ownership relative to the authenticating user","enum":["user-owned","non-user-owned"]},"timestamp":{"type":"string","description":"Timestamp of the authentication event","format":"date-time"}},"required":["device_id","device_ownership","timestamp"]}},"components/schemas/ApiUserAuthenticatorLockout":{"id":"components/schemas/ApiUserAuthenticatorLockout","kind":"json-schema","title":"ApiUserAuthenticatorLockout","data":{"type":"object","properties":{"suspended_until":{"format":"date-time","type":"string","description":"Lockout remaining time"},"suspended_at":{"format":"date-time","type":"string"},"remaining_attempts":{"type":"number","description":"Remaining attempts"},"current_tier":{"type":"number","description":"Tier number"},"auto":{"type":"boolean","description":"Whether the lockout was triggered automatically and suspension is still active"}}}},"components/schemas/RegisteringDevice":{"id":"components/schemas/RegisteringDevice","kind":"json-schema","title":"RegisteringDevice","data":{"type":"object","properties":{"device_id":{"type":"string","description":"The device ID provided during registration."},"timestamp":{"type":"string","description":"The timestamp when the device was registered.","format":"date-time"}},"required":["device_id","timestamp"]}},"components/schemas/ApiEmailMagicLinkExtraData":{"id":"components/schemas/ApiEmailMagicLinkExtraData","kind":"json-schema","title":"ApiEmailMagicLinkExtraData","data":{"type":"object","properties":{"email":{"type":"string","description":"The email address"},"verified":{"type":"boolean","description":"Indicates whether the email was verified"},"verified_at":{"format":"date-time","type":"string","description":"The date the email was verified"}},"required":["email","verified","verified_at"]}},"components/schemas/ApiEmailOtpExtraData":{"id":"components/schemas/ApiEmailOtpExtraData","kind":"json-schema","title":"ApiEmailOtpExtraData","data":{"type":"object","properties":{"email":{"type":"string","description":"The email address"},"verified":{"type":"boolean","description":"Indicates whether the email was verified"},"verified_at":{"format":"date-time","type":"string","description":"The date the email was verified"}},"required":["email","verified","verified_at"]}},"components/schemas/ApiSmsOtpExtraData":{"id":"components/schemas/ApiSmsOtpExtraData","kind":"json-schema","title":"ApiSmsOtpExtraData","data":{"type":"object","properties":{"phone_number":{"type":"string","description":"The phone number"},"verified":{"type":"boolean","description":"Indicates whether the phone number was verified"},"verified_at":{"format":"date-time","type":"string","description":"The date the phone number was verified"}},"required":["phone_number","verified","verified_at"]}},"components/schemas/ApiTotpExtraData":{"id":"components/schemas/ApiTotpExtraData","kind":"json-schema","title":"ApiTotpExtraData","data":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the user"},"phone_number":{"type":"string","description":"The phone number of the user"},"username":{"type":"string","description":"The username of the user"},"digits":{"type":"number","description":"The number of digits in the token"},"period":{"type":"number","description":"The period of time the token is valid for"},"algorithm":{"type":"string","description":"The algorithm used to generate the token"},"issuer":{"type":"string","description":"The issuer of the token"}},"required":["digits","period","algorithm","issuer"]}},"components/schemas/ApiGoogleExtraData":{"id":"components/schemas/ApiGoogleExtraData","kind":"json-schema","title":"ApiGoogleExtraData","data":{"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the user in the social network"},"email":{"type":"string","description":"The email address"}},"required":["identifier","email"]}},"components/schemas/ApiFacebookExtraData":{"id":"components/schemas/ApiFacebookExtraData","kind":"json-schema","title":"ApiFacebookExtraData","data":{"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the user in the social network"},"email":{"type":"string","description":"The email address"}},"required":["identifier","email"]}},"components/schemas/ApiAppleExtraData":{"id":"components/schemas/ApiAppleExtraData","kind":"json-schema","title":"ApiAppleExtraData","data":{"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the user in the social network"},"email":{"type":"string","description":"The email address"}},"required":["identifier","email"]}},"components/schemas/ApiLineExtraData":{"id":"components/schemas/ApiLineExtraData","kind":"json-schema","title":"ApiLineExtraData","data":{"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the user in the social network"},"email":{"type":"string","description":"The email address"}},"required":["identifier","email"]}},"components/schemas/ApiSamlExtraData":{"id":"components/schemas/ApiSamlExtraData","kind":"json-schema","title":"ApiSamlExtraData","data":{"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the user in the social network"},"email":{"type":"string","description":"The email address"}},"required":["identifier","email"]}},"components/schemas/ApiOidcExtraData":{"id":"components/schemas/ApiOidcExtraData","kind":"json-schema","title":"ApiOidcExtraData","data":{"type":"object","properties":{"identifier":{"type":"string","description":"The identifier of the user in the social network"},"email":{"type":"string","description":"The email address"}},"required":["identifier","email"]}},"components/schemas/ApiPasswordExtraData":{"id":"components/schemas/ApiPasswordExtraData","kind":"json-schema","title":"ApiPasswordExtraData","data":{"type":"object","properties":{"app_id":{"type":"string","description":"The app id","deprecated":true},"app_name":{"type":"string","description":"The name of the app"},"updated_at":{"format":"date-time","type":"string","description":"The date the password was last updated"},"created_at":{"format":"date-time","type":"string","description":"The date the password was created"},"username":{"type":"string","description":"The username of the user"},"expired":{"type":"boolean","description":"Whether the password is currently expired"},"temporary":{"type":"boolean","description":"Whether the password is temporary and must be reset after first use"},"expires_in":{"format":"date-time","type":"string","description":"The date the password will be expired"}},"required":["app_id","updated_at","expired","temporary"]}},"components/schemas/ApiWebauthnExtraData":{"id":"components/schemas/ApiWebauthnExtraData","kind":"json-schema","title":"ApiWebauthnExtraData","data":{"type":"object","properties":{"credential_id":{"type":"string","description":"WebAuthn credential ID (passkey ID)"},"rpId":{"type":"string","description":"Relying Party ID"},"identifier":{"type":"string","description":"The user identifier"},"devices":{"description":"List of devices","type":"array","items":{"$ref":"#/components/schemas/ApiUserWebauthnDeviceMetadataDto"}},"aaguid_info":{"description":"The authenticator's AAGUID Information","allOf":[{"$ref":"#/components/schemas/AAGUIDInfo"}]},"public_key":{"type":"string","description":"Public credential key for WebAuthn credentials"},"passkey_type":{"type":"string","enum":["synced","device_bound"],"description":"Passkey type, synced across devices or bound to a single device"},"sync_status":{"type":"string","enum":["synced","not_synced"],"description":"Backup state of the passkey. Only present for synced passkeys."},"attestation_status":{"type":"string","enum":["attested","unattested"],"description":"Reflects certificate chain validation at registration and current FIDO MDS status verification"}},"required":["credential_id","rpId","identifier","devices","public_key"]}},"components/schemas/ApiMobileBiometricExtraData":{"id":"components/schemas/ApiMobileBiometricExtraData","kind":"json-schema","title":"ApiMobileBiometricExtraData","data":{"type":"object","properties":{"algorithm":{"type":"string","description":"The type of biometric"},"origin":{"type":"string","description":"The origin of the biometric"}},"required":["algorithm","origin"]}},"components/schemas/ApiPinAuthenticatorExtraData":{"id":"components/schemas/ApiPinAuthenticatorExtraData","kind":"json-schema","title":"ApiPinAuthenticatorExtraData","data":{"type":"object","properties":{"algorithm":{"type":"string","description":"The type of biometric"},"origin":{"type":"string","description":"The origin of the biometric"},"displayName":{"type":"string","description":"The display name of the biometric"}},"required":["algorithm","origin","displayName"]}},"components/schemas/ApiUserWebauthnDeviceMetadataDto":{"id":"components/schemas/ApiUserWebauthnDeviceMetadataDto","kind":"json-schema","title":"ApiUserWebauthnDeviceMetadataDto","data":{"type":"object","properties":{"os_type":{"type":"string","description":"Device OS type"},"os_version":{"type":"string","description":"Device OS version"},"browser":{"type":"string","description":"Browser name"},"user_agent":{"type":"string","description":"User agent"},"first_seen":{"type":"string","description":"Date the credential was first used by this device, in ISO 8601"},"last_seen":{"type":"string","description":"Date the credential was last used by this device, in ISO 8601"}},"required":["os_type","os_version","browser","user_agent","first_seen","last_seen"]}},"components/schemas/AAGUIDInfo":{"id":"components/schemas/AAGUIDInfo","kind":"json-schema","title":"AAGUIDInfo","data":{"type":"object","properties":{"aaguid":{"type":"string","description":"The authenticator AAGUID"},"passkey_provider_name":{"type":"string","description":"The authenticator name"},"status":{"type":"string","description":"The authenticator certificate status"}}}},"schema_328":{"kind":"json-schema","data":{"type":"string"},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"type":"string","enum":["totp","email_magic_link","email_otp","sms_otp","direct_otp","webauthn","password","mobile_biometric","pin_authenticator","face"]},"id":"schema_329"}},"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/authenticators.openapi.json?download"},{"url":"/_bundle/openapi/user/authenticators.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"User Authenticators","description":"Manage user authenticators, such as WebAuthn credentials, TOTP authenticators, and more. These APIs allow you to view and manage the authenticators that were registered for a given user."}},"baseSlug":"/openapi/user/authenticators.openapi","routesMapping":{}}