{"items":[{"type":"link","label":"WebAuthn Cross-Device","link":"/openapi/user/backend-webauthn-cross-device.openapi","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi","content":{"contentType":"overview","meta":{"name":"WebAuthn Cross-Device"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"backend-webauthn-cross-device.openapi.json","url":"/_bundle/openapi/user/backend-webauthn-cross-device.openapi.json?download"},{"kind":"download","label":"backend-webauthn-cross-device.openapi.yaml","url":"/_bundle/openapi/user/backend-webauthn-cross-device.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":"WebAuthn Cross-Device","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"APIs to manage cross-device flow for WebAuthn registration and authentication."}],"sectionId":"/openapi/user/backend-webauthn-cross-device.openapi"}],"sectionId":"/openapi/user/backend-webauthn-cross-device.openapi"}]}]}},{"label":"Start registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-registration-start","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-registration-start","metadata":{"seo":{"title":"Start registration","description":"Starts a WebAuthn registration process on a secondary device, and returns a challenge for the client to sign. If successful, the response contains a credential_creation_options field that should be passed to the WebAuthn navigator.credentials.create() API call. Note: Some fields, such as user.id and challenge, are binary values represented as base64url-encoded strings. Before calling the WebAuthn API, parse the options using PublicKeyCredential.parseCreationOptionsFromJSON()."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-cross-device-registration-start","name":"Start registration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start registration","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 WebAuthn registration process on a secondary device, and returns a challenge for the client to sign. If successful, the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credential_creation_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field that should be passed to the WebAuthn "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.credentials.create()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API call. "},"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":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Some fields, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", are binary values represented as base64url-encoded strings. Before calling the WebAuthn API, parse the options using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PublicKeyCredential.parseCreationOptionsFromJSON()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceRegisterStartRequestDto"}},"schemaId":"components/schemas/ApiCrossDeviceRegisterStartRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/cross-device/register/start","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/ApiCrossDeviceRegisterStartRequestDto"}},"responseCodes":["200","400","404"],"pointer":"/v1/auth/webauthn/cross-device/register/start","href":"other/webauthn-cross-device-registration-start","openApiOperationId":"webauthn-cross-device-registration-start","summary":"Start registration"},"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/ApiCrossDeviceRegisterStartRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceRegisterStartRequestDto"}},"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/WebauthnRegisterStartResponseDto"}},"schemaId":"components/schemas/WebauthnRegisterStartResponseDto"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/400/content/application~1json/examples/InvalidRequest"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/400/content/application~1json/examples/InvalidRequest"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebauthnRegisterStartResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterStartResponseDto"}}},{"code":"400","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/400/content/application~1json/examples/InvalidRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/400/content/application~1json/examples/InvalidRequest"]}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/cross-device/register/start"},{"label":"Init logged-in registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-registration-init","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-registration-init","metadata":{"seo":{"title":"Init logged-in registration","description":"Initializes a flow that will register WebAuthn credentials using a secondary device. Requested by the access device (e.g., desktop) and requires a logged-in user. Returns cross_device_ticket_id, which should be passed to the biometric device to start the device registration, such as by encoding it in a QR code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-cross-device-registration-init","name":"Init logged-in registration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Init logged-in registration","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":"Initializes a flow that will register WebAuthn credentials using a secondary device. Requested by the access device (e.g., desktop) and requires a logged-in user. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cross_device_ticket_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which should be passed to the biometric device to start the device registration, such as by encoding it in a QR code."},"children":[]}]}]}]},{"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"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceRegisterInitRequestDto"}},"schemaId":"components/schemas/ApiCrossDeviceRegisterInitRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/cross-device/register/init","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":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceRegisterInitRequestDto"}},"responseCodes":["200","400","404"],"pointer":"/v1/auth/webauthn/cross-device/register/init","href":"other/webauthn-cross-device-registration-init","openApiOperationId":"webauthn-cross-device-registration-init","summary":"Init logged-in registration"},"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/ApiCrossDeviceRegisterInitRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceRegisterInitRequestDto"}},"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/ApiCrossDeviceInitResponseDto"}},"schemaId":"components/schemas/ApiCrossDeviceInitResponseDto"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiCrossDeviceInitResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceInitResponseDto"}}},{"code":"400","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"]}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/cross-device/register/init"},{"label":"Init logged-out registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-external-registration-init","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-external-registration-init","metadata":{"seo":{"title":"Init logged-out registration","description":"Initializes a flow that will register WebAuthn credentials using a secondary device. Requested by the access device (e.g., desktop) for a user that isn't logged in via Transmit (e.g., after password login via an external identity provider). Returns cross_device_ticket_id, which should be passed to the biometric device to start the device registration, such as by encoding it in a QR code. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-cross-device-external-registration-init","name":"Init logged-out registration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Init logged-out registration","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":"Initializes a flow that will register WebAuthn credentials using a secondary device. Requested by the access device (e.g., desktop) for a user that isn't logged in via Transmit (e.g., after password login via an external identity provider). Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cross_device_ticket_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which should be passed to the biometric device to start the device registration, such as by encoding it in a QR code. "},"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/ApiCrossDeviceExternalRegisterInitRequestDto"}},"schemaId":"components/schemas/ApiCrossDeviceExternalRegisterInitRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/cross-device/external/register/init","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/ApiCrossDeviceExternalRegisterInitRequestDto"}},"responseCodes":["200","400","404"],"pointer":"/v1/auth/webauthn/cross-device/external/register/init","href":"other/webauthn-cross-device-external-registration-init","openApiOperationId":"webauthn-cross-device-external-registration-init","summary":"Init logged-out registration"},"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/ApiCrossDeviceExternalRegisterInitRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceExternalRegisterInitRequestDto"}},"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/ApiCrossDeviceInitResponseDto"}},"schemaId":"components/schemas/ApiCrossDeviceInitResponseDto"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiCrossDeviceInitResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceInitResponseDto"}}},{"code":"400","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"]}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/cross-device/external/register/init"},{"label":"Complete registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-registration","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-registration","metadata":{"seo":{"title":"Complete registration","description":"Completes WebAuthn credential registration for the user on a secondary device. For a logged-in registration flow, the user is derived from the access token. For a logged-out registration flow, the user corresponds to the requested external user ID. If no user is found, a new user will be created. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-cross-device-registration","name":"Complete registration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1register/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete registration","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":"Completes WebAuthn credential registration for the user on a secondary device. For a logged-in registration flow, the user is derived from the access token. For a logged-out registration flow, the user corresponds to the requested external user ID. If no user is found, a new user will be created. "},"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/WebauthnRegisterCompleteRequestDto"}},"schemaId":"components/schemas/WebauthnRegisterCompleteRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1register/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/cross-device/register","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/WebauthnRegisterCompleteRequestDto"}},"responseCodes":["200","400"],"pointer":"/v1/auth/webauthn/cross-device/register","href":"other/webauthn-cross-device-registration","openApiOperationId":"webauthn-cross-device-registration","summary":"Complete registration"},"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/WebauthnRegisterCompleteRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterCompleteRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Registered credential details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterCompleteExternalResponseDto"}},"schemaId":"components/schemas/WebauthnRegisterCompleteExternalResponseDto"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register/post/responses/400/content/application~1json/examples/InvalidRequest"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register/post/responses/400/content/application~1json/examples/InvalidRequest"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1register/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebauthnRegisterCompleteExternalResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterCompleteExternalResponseDto"}}},{"code":"400","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register/post/responses/400/content/application~1json/examples/InvalidRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1register/post/responses/400/content/application~1json/examples/InvalidRequest"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/cross-device/register"},{"label":"Abort cross-device flow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-abort","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-abort","metadata":{"seo":{"title":"Abort cross-device flow","description":"Terminates the cross-device flow from the auth device, and updates the status to aborted. Required permissions: apps:execute, [appId]:execute, auth:execute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-cross-device-abort","name":"Abort cross-device flow","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1abort/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Abort cross-device flow","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":"Terminates the cross-device flow from the auth device, and updates the status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aborted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"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/ApiCrossDeviceTicketIdRequestDto"}},"schemaId":"components/schemas/ApiCrossDeviceTicketIdRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/cross-device/abort","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/ApiCrossDeviceTicketIdRequestDto"}},"responseCodes":["204","400","404"],"pointer":"/v1/auth/webauthn/cross-device/abort","href":"other/webauthn-cross-device-abort","openApiOperationId":"webauthn-cross-device-abort","summary":"Abort cross-device flow"},"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/ApiCrossDeviceTicketIdRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceTicketIdRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/400/content/application~1json/examples/InvalidRequest"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/400/content/application~1json/examples/InvalidRequest"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/400/content/application~1json/examples/InvalidRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/400/content/application~1json/examples/InvalidRequest"]}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/cross-device/abort"},{"label":"Get cross-device status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-status","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-status","metadata":{"seo":{"title":"Get cross-device status","description":"Checks the status of a cross-device flow. This is used by the access device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-cross-device-status","name":"Get cross-device status","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get cross-device status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Checks the status of a cross-device flow. This is used by the access device."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cross_device_ticket_id","in":"query","schemaId":"schema_346","required":true}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/auth/webauthn/cross-device/status","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":[{"name":"cross_device_ticket_id","in":"query","required":true,"schemaId":"schema_346"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/v1/auth/webauthn/cross-device/status","href":"other/webauthn-cross-device-status","openApiOperationId":"webauthn-cross-device-status","summary":"Get cross-device status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiWebauthnCrossDeviceStatusResponse"}},"schemaId":"components/schemas/ApiWebauthnCrossDeviceStatusResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/400/content/application~1json/examples/InvalidRequest"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/400/content/application~1json/examples/InvalidRequest"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiWebauthnCrossDeviceStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiWebauthnCrossDeviceStatusResponse"}}},{"code":"400","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/400/content/application~1json/examples/InvalidRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/400/content/application~1json/examples/InvalidRequest"]}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/cross-device/status"},{"label":"Attach device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-attach-device","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-attach-device","metadata":{"seo":{"title":"Attach device","description":"Indicates that the auth device has engaged in the flow, such as when the user scans a QR encoding the cross-device ticket ID. This updates the flow status to scanned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-cross-device-attach-device","name":"Attach device","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach device","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":"Indicates that the auth device has engaged in the flow, such as when the user scans a QR encoding the cross-device ticket ID. This updates the flow status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scanned"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceTicketIdRequestDto"}},"schemaId":"components/schemas/ApiCrossDeviceTicketIdRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/cross-device/attach-device","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/ApiCrossDeviceTicketIdRequestDto"}},"responseCodes":["200","400","404"],"pointer":"/v1/auth/webauthn/cross-device/attach-device","href":"other/webauthn-cross-device-attach-device","openApiOperationId":"webauthn-cross-device-attach-device","summary":"Attach device"},"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/ApiCrossDeviceTicketIdRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceTicketIdRequestDto"}},"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/ApiCrossDeviceAttachDeviceResponseDto"}},"schemaId":"components/schemas/ApiCrossDeviceAttachDeviceResponseDto"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/400/content/application~1json/examples/InvalidRequest"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/400/content/application~1json/examples/InvalidRequest"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiCrossDeviceAttachDeviceResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceAttachDeviceResponseDto"}}},{"code":"400","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/400/content/application~1json/examples/InvalidRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/400/content/application~1json/examples/InvalidRequest"]}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/cross-device/attach-device"},{"label":"Init authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-authentication-init","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-authentication-init","metadata":{"seo":{"title":"Init authentication","description":"Initializes a flow that will authenticate WebAuthn credentials using a secondary device. Requested by the access device (e.g., desktop) before delegating authentication to another device. Returns a cross-device ticket ID that should be passed to the biometric device to start the authentication (e.g., by encoding it in a QR code)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-cross-device-authentication-init","name":"Init authentication","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Init authentication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initializes a flow that will authenticate WebAuthn credentials using a secondary device. Requested by the access device (e.g., desktop) before delegating authentication to another device. Returns a cross-device ticket ID that should be passed to the biometric device to start the authentication (e.g., by encoding it in a QR code)."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceAuthenticateInitRequestDto"}},"schemaId":"components/schemas/ApiCrossDeviceAuthenticateInitRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/cross-device/authenticate/init","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/ApiCrossDeviceAuthenticateInitRequestDto"}},"responseCodes":["200","400","404"],"pointer":"/v1/auth/webauthn/cross-device/authenticate/init","href":"other/webauthn-cross-device-authentication-init","openApiOperationId":"webauthn-cross-device-authentication-init","summary":"Init authentication"},"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/ApiCrossDeviceAuthenticateInitRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceAuthenticateInitRequestDto"}},"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/ApiCrossDeviceInitResponseDto"}},"schemaId":"components/schemas/ApiCrossDeviceInitResponseDto"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/400/content/application~1json/examples/InvalidRequest"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/400/content/application~1json/examples/InvalidRequest"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/404/content/application~1json/examples/ClientNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/404/content/application~1json/examples/ClientNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiCrossDeviceInitResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceInitResponseDto"}}},{"code":"400","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/400/content/application~1json/examples/InvalidRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/400/content/application~1json/examples/InvalidRequest"]}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/404/content/application~1json/examples/ClientNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/404/content/application~1json/examples/ClientNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/cross-device/authenticate/init"},{"label":"Start authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-authenticate-start","routeSlug":"/openapi/user/backend-webauthn-cross-device.openapi/other/webauthn-cross-device-authenticate-start","metadata":{"seo":{"title":"Start authentication","description":"Starts a WebAuthn authentication process using a secondary device. If successful, the response contains a credential_request_options field that should be passed to the WebAuthn navigator.credentials.get() API call. Note: Some fields, such as challenge and each id in the allowCredentials list, are binary values represented as base64url-encoded strings. Before calling the WebAuthn API, parse the options using PublicKeyCredential.parseRequestOptionsFromJSON()."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-cross-device-authenticate-start","name":"Start authentication","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start authentication","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 WebAuthn authentication process using a secondary device. If successful, the response contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credential_request_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field that should be passed to the WebAuthn "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.credentials.get()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API call. "},"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":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Some fields, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowCredentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list, are binary values represented as base64url-encoded strings. Before calling the WebAuthn API, parse the options using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PublicKeyCredential.parseRequestOptionsFromJSON()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceAuthenticateStartRequestDto"}},"schemaId":"components/schemas/ApiCrossDeviceAuthenticateStartRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/cross-device/authenticate/start","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/ApiCrossDeviceAuthenticateStartRequestDto"}},"responseCodes":["200","400","404"],"pointer":"/v1/auth/webauthn/cross-device/authenticate/start","href":"other/webauthn-cross-device-authenticate-start","openApiOperationId":"webauthn-cross-device-authenticate-start","summary":"Start authentication"},"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/ApiCrossDeviceAuthenticateStartRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiCrossDeviceAuthenticateStartRequestDto"}},"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/ApiWebAuthnAuthenticateStartResponse"}},"schemaId":"components/schemas/ApiWebAuthnAuthenticateStartResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/400/content/application~1json/examples/InvalidRequest"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/400/content/application~1json/examples/InvalidRequest"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiWebAuthnAuthenticateStartResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiWebAuthnAuthenticateStartResponse"}}},{"code":"400","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/400/content/application~1json/examples/InvalidRequest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/400/content/application~1json/examples/InvalidRequest"]}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/cross-device/authenticate/start"}],"store":{"schemaStore":{"components/schemas/ApiCrossDeviceExternalRegisterInitRequestDto":{"id":"components/schemas/ApiCrossDeviceExternalRegisterInitRequestDto","kind":"json-schema","title":"ApiCrossDeviceExternalRegisterInitRequestDto","data":{"type":"object","properties":{"external_user_id":{"type":"string","description":"A unique identifier in the tenant, which corresponds to an identifier of the user in your system.","maxLength":64,"minLength":1},"username":{"type":"string","description":"Account name for this Relying Party. This is used both for display purposes, as well as during recovery flows where the user is asked for the account name."}},"required":["external_user_id","username"]}},"components/schemas/ApiCrossDeviceInitResponseDto":{"id":"components/schemas/ApiCrossDeviceInitResponseDto","kind":"json-schema","title":"ApiCrossDeviceInitResponseDto","data":{"type":"object","properties":{"cross_device_ticket_id":{"type":"string","description":"Identifies the cross-device flow. Required for starting the flow on the secondary device."}},"required":["cross_device_ticket_id"]}},"components/schemas/WebauthnRegisterCompleteRequestDto":{"id":"components/schemas/WebauthnRegisterCompleteRequestDto","kind":"json-schema","title":"WebauthnRegisterCompleteRequestDto","data":{"type":"object","properties":{"webauthn_encoded_result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebAuthn attestation data returned by the browser upon credential creation. If the credential was created using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navigator.credentials.create()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toJSON()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PublicKeyCredential"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before sending it to the backend. Optionally include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deviceInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publicKeyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"publicKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the same object to bind the device to the user, so it appears in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device_keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim of the ID token after passkey login."},"children":[]}]}]}]},"device_id":{"type":"string","description":"The device associated with this registration."}},"required":["webauthn_encoded_result"]}},"components/schemas/WebauthnRegisterCompleteExternalResponseDto":{"id":"components/schemas/WebauthnRegisterCompleteExternalResponseDto","kind":"json-schema","title":"WebauthnRegisterCompleteExternalResponseDto","data":{"type":"object","properties":{"webauthn_session_id":{"type":"string","description":"WebAuthn session identifier"},"user_id":{"type":"string","description":"Transmit user ID, autogenerated upon user creation"},"webauthn_username":{"type":"string","description":"Name of user account, as specified in the WebAuthn registration"},"credential_id":{"type":"string","description":"WebAuthn credential ID"},"authenticator_attachment":{"type":"string","enum":["platform","cross-platform"],"description":"The authenticators' attachment modalities. Cross-platform authenticator are external to the current device, such as a USB security key or a different device"},"aaguid":{"type":"string","description":"The authenticator's AAGUID"},"external_user_id":{"type":"string","description":"External User identifier"},"is_user_created":{"type":"boolean","description":"Indicates if this is a new user or not"}},"required":["webauthn_session_id","webauthn_username","credential_id","authenticator_attachment","external_user_id","is_user_created"]}},"components/schemas/ApiCrossDeviceTicketIdRequestDto":{"id":"components/schemas/ApiCrossDeviceTicketIdRequestDto","kind":"json-schema","title":"ApiCrossDeviceTicketIdRequestDto","data":{"type":"object","properties":{"cross_device_ticket_id":{"type":"string","description":"Webauthn cross device ticket ID"}},"required":["cross_device_ticket_id"]}},"components/schemas/ApiCrossDeviceRegisterInitRequestDto":{"id":"components/schemas/ApiCrossDeviceRegisterInitRequestDto","kind":"json-schema","title":"ApiCrossDeviceRegisterInitRequestDto","data":{"type":"object","properties":{"username":{"type":"string","description":"Account name for this Relying Party. This is used both for display purposes, as well as during recovery flows where the user is asked for the account name."},"limit_single_credential_to_device":{"type":"boolean","description":"Set to True in order to limit the creation of multiple credentials for the same account on a single authenticator. Default is False.","default":false}},"required":["username"]}},"components/schemas/ApiWebauthnCrossDeviceStatusResponse":{"id":"components/schemas/ApiWebauthnCrossDeviceStatusResponse","kind":"json-schema","title":"ApiWebauthnCrossDeviceStatusResponse","data":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/WebauthnCrossDeviceStatus"},"session_id":{"type":"string","description":"session id return on cross device authentication success"}},"required":["status","session_id"]}},"components/schemas/ApiCrossDeviceAttachDeviceResponseDto":{"id":"components/schemas/ApiCrossDeviceAttachDeviceResponseDto","kind":"json-schema","title":"ApiCrossDeviceAttachDeviceResponseDto","data":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/WebauthnCrossDeviceStatus"},"started_at":{"type":"string"},"approval_data":{"type":"object","example":{"transaction_id":"eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT","sum":"200"},"description":"Flat object that contains the data that your customer should approve for a transaction signing or custom approval flow. It can contain up to 10 keys, and only alphanumeric characters, underscores, hyphens, and periods. It will be returned as a claim in the ID token upon successful authentication."}},"required":["status"]}},"components/schemas/ApiCrossDeviceAuthenticateInitRequestDto":{"id":"components/schemas/ApiCrossDeviceAuthenticateInitRequestDto","kind":"json-schema","title":"ApiCrossDeviceAuthenticateInitRequestDto","data":{"type":"object","properties":{"client_id":{"type":"string","description":"The client ID of the application the user is trying to authenticate to."},"username":{"type":"string","description":"Name of user account, as used in the WebAuthn registration. If not provided, the authentication will start without the context of a user and it will be inferred by the chosen passkey"},"approval_data":{"type":"object","example":{"transaction_id":"eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT","sum":"200"},"description":"Flat object that contains the data that your customer should approve for a transaction signing or custom approval flow. It can contain up to 10 keys, and only alphanumeric characters, underscores, hyphens, and periods. It will be returned as a claim in the ID token upon successful authentication."}},"required":["client_id"]}},"components/schemas/ApiCrossDeviceAuthenticateStartRequestDto":{"id":"components/schemas/ApiCrossDeviceAuthenticateStartRequestDto","kind":"json-schema","title":"ApiCrossDeviceAuthenticateStartRequestDto","data":{"type":"object","properties":{"cross_device_ticket_id":{"type":"string","description":"Returned upon initializing the authentication flow"}},"required":["cross_device_ticket_id"]}},"components/schemas/ApiWebAuthnAuthenticateStartResponse":{"id":"components/schemas/ApiWebAuthnAuthenticateStartResponse","kind":"json-schema","title":"ApiWebAuthnAuthenticateStartResponse","data":{"type":"object","properties":{"webauthn_session_id":{"type":"string","description":"WebAuthn session identifier"},"credential_request_options":{"$ref":"#/components/schemas/WebAuthnAuthenticationOptions"}},"required":["webauthn_session_id","credential_request_options"]}},"components/schemas/ApiCrossDeviceRegisterStartRequestDto":{"id":"components/schemas/ApiCrossDeviceRegisterStartRequestDto","kind":"json-schema","title":"ApiCrossDeviceRegisterStartRequestDto","data":{"type":"object","properties":{"cross_device_ticket_id":{"type":"string","description":"cross device ticket id returned from the init cross device registration API"}},"required":["cross_device_ticket_id"]}},"components/schemas/WebauthnRegisterStartResponseDto":{"id":"components/schemas/WebauthnRegisterStartResponseDto","kind":"json-schema","title":"WebauthnRegisterStartResponseDto","data":{"type":"object","properties":{"webauthn_session_id":{"type":"string","description":"WebAuthn session identifier"},"credential_creation_options":{"$ref":"#/components/schemas/WebauthnRegistrationOptions"}},"required":["webauthn_session_id","credential_creation_options"]}},"components/schemas/WebauthnCrossDeviceStatus":{"id":"components/schemas/WebauthnCrossDeviceStatus","kind":"json-schema","title":"WebauthnCrossDeviceStatus","data":{"type":"string","enum":["pending","scanned","success","error","timeout","aborted"]}},"components/schemas/WebAuthnAuthenticationOptions":{"id":"components/schemas/WebAuthnAuthenticationOptions","kind":"json-schema","title":"WebAuthnAuthenticationOptions","data":{"type":"object","properties":{"allowCredentials":{"type":"array","items":{"$ref":"#/components/schemas/AuthenticationOptionsAllowedCredential"}},"rawChallenge":{"type":"string","description":"Represents the natural WebAuthn challenge. Will Only be present in approval flows"},"challenge":{"type":"string"},"timeout":{"type":"number"},"rpId":{"type":"string","description":"Relying Party ID. Must be a valid domain pre-configured in the Admin Portal for the application","pattern":"/^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]\\.[a-zA-Z]{2,}$/"},"attestation":{"type":"string","enum":["none"],"example":"none","default":"none"},"userVerification":{"type":"string","enum":["preferred","required"],"default":"preferred","example":"preferred"},"extensions":{"type":"object"}},"required":["allowCredentials","challenge","rpId"]}},"components/schemas/WebauthnRegistrationOptions":{"id":"components/schemas/WebauthnRegistrationOptions","kind":"json-schema","title":"WebauthnRegistrationOptions","data":{"type":"object","properties":{"attestation":{"type":"string","enum":["none"],"default":"none"},"authenticatorSelection":{"$ref":"#/components/schemas/ApiAuthenticatorSelectionCriteria"},"extensions":{"$ref":"#/components/schemas/ApiAuthenticationExtensionsClientInputs"},"excludeCredentials":{"type":"array","items":{"type":"string"}},"pubKeyCredParams":{"type":"array","items":{"$ref":"#/components/schemas/ApiPublicKeyCredentialParameters"}},"timeout":{"type":"number"},"challenge":{"type":"string"},"user":{"$ref":"#/components/schemas/ApiRegistrationOptionsUser"},"rp":{"$ref":"#/components/schemas/ApiRegistrationOptionsRp"}},"required":["pubKeyCredParams","challenge","user","rp"]}},"components/schemas/ApiAuthenticatorSelectionCriteria":{"id":"components/schemas/ApiAuthenticatorSelectionCriteria","kind":"json-schema","title":"ApiAuthenticatorSelectionCriteria","data":{"type":"object","properties":{"authenticatorAttachment":{"type":"string","enum":["platform","cross-platform"],"description":"The authenticators' attachment modalities. Cross-platform authenticator are external to the current device, such as a USB security key or a different device","default":"platform"},"requireResidentKey":{"type":"boolean"},"residentKey":{"type":"object"},"userVerification":{"type":"string","enum":["preferred","required"],"default":"preferred"}}}},"components/schemas/ApiAuthenticationExtensionsClientInputs":{"id":"components/schemas/ApiAuthenticationExtensionsClientInputs","kind":"json-schema","title":"ApiAuthenticationExtensionsClientInputs","data":{"type":"object","properties":{"appid":{"type":"string"},"credProps":{"type":"boolean"},"hmacCreateSecret":{"type":"boolean"}}}},"components/schemas/ApiRegistrationOptionsUser":{"id":"components/schemas/ApiRegistrationOptionsUser","kind":"json-schema","title":"ApiRegistrationOptionsUser","data":{"type":"object","properties":{"id":{"type":"string","description":"User handle"},"name":{"type":"string","description":"The webauthn username"},"displayName":{"type":"string","description":"The user display name"}},"required":["id","name","displayName"]}},"components/schemas/ApiRegistrationOptionsRp":{"id":"components/schemas/ApiRegistrationOptionsRp","kind":"json-schema","title":"ApiRegistrationOptionsRp","data":{"type":"object","properties":{"id":{"type":"string","description":"Relying Party ID. Must be a valid domain pre-configured in the Admin Portal for the application","pattern":"/^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]\\.[a-zA-Z]{2,}$/"},"name":{"type":"string","description":"Relying party displayable name"},"icon":{"type":"string"}},"required":["id","name","icon"]}},"components/schemas/AuthenticationOptionsAllowedCredential":{"id":"components/schemas/AuthenticationOptionsAllowedCredential","kind":"json-schema","title":"AuthenticationOptionsAllowedCredential","data":{"type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key type. Should always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public-key"},"children":[]}]}]}],"enum":["public-key"],"default":"public-key","example":"public-key"},"id":{"type":"string","description":"The credential ID"},"transports":{"type":"array","default":["internal"],"example":["internal"],"items":{"type":"string","enum":["internal"]}}},"required":["type","id","transports"]}},"components/schemas/ApiPublicKeyCredentialParameters":{"id":"components/schemas/ApiPublicKeyCredentialParameters","kind":"json-schema","title":"ApiPublicKeyCredentialParameters","data":{"type":"object","properties":{"alg":{"type":"number"},"type":{"type":"string","example":"public-key","default":"public-key","enum":["public-key"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key type. Should always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public-key"},"children":[]}]}]}]}},"required":["alg","type"]}},"schema_346":{"kind":"json-schema","data":{"type":"string"},"id":"schema_346"}},"exampleStore":{"paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/400/content/application~1json/examples/InvalidRequest":{"value":{"error_code":"invalid_request","message":"Invalid request: property should not be null or undefined"},"key":"InvalidRequest","summary":"InvalidRequest","id":"paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/400/content/application~1json/examples/InvalidRequest"},"paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound":{"value":{"error_code":"cross_device_ticket_not_found","message":"Cross device ticket not found"},"key":"CrossDeviceTicketNotFound","summary":"CrossDeviceTicketNotFound","description":"When the ticketId doesn't exist","id":"paths/~1v1~1auth~1webauthn~1cross-device~1register~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"},"paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest":{"value":{"error_code":"invalid_request","message":"Invalid request: property should not be null or undefined"},"key":"InvalidRequest","summary":"InvalidRequest","id":"paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"},"paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound":{"value":{"error_code":"client_not_found","message":"Client not found"},"key":"ClientNotFound","summary":"ClientNotFound","description":"When the clientId doesn't exist","id":"paths/~1v1~1auth~1webauthn~1cross-device~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"},"paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest":{"value":{"error_code":"invalid_request","message":"Invalid request: property should not be null or undefined"},"key":"InvalidRequest","summary":"InvalidRequest","id":"paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/400/content/application~1json/examples/InvalidRequest"},"paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound":{"value":{"error_code":"client_not_found","message":"Client not found"},"key":"ClientNotFound","summary":"ClientNotFound","description":"When the clientId doesn't exist","id":"paths/~1v1~1auth~1webauthn~1cross-device~1external~1register~1init/post/responses/404/content/application~1json/examples/ClientNotFound"},"paths/~1v1~1auth~1webauthn~1cross-device~1register/post/responses/400/content/application~1json/examples/InvalidRequest":{"value":{"error_code":"invalid_request","message":"Invalid request: property should not be null or undefined"},"key":"InvalidRequest","summary":"InvalidRequest","id":"paths/~1v1~1auth~1webauthn~1cross-device~1register/post/responses/400/content/application~1json/examples/InvalidRequest"},"paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/400/content/application~1json/examples/InvalidRequest":{"value":{"error_code":"invalid_request","message":"Invalid request: property should not be null or undefined"},"key":"InvalidRequest","summary":"InvalidRequest","id":"paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/400/content/application~1json/examples/InvalidRequest"},"paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound":{"value":{"error_code":"cross_device_ticket_not_found","message":"Cross device ticket not found"},"key":"CrossDeviceTicketNotFound","summary":"CrossDeviceTicketNotFound","description":"When the ticketId doesn't exist","id":"paths/~1v1~1auth~1webauthn~1cross-device~1abort/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"},"paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/400/content/application~1json/examples/InvalidRequest":{"value":{"error_code":"invalid_request","message":"Invalid request: property should not be null or undefined"},"key":"InvalidRequest","summary":"InvalidRequest","id":"paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/400/content/application~1json/examples/InvalidRequest"},"paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound":{"value":{"error_code":"cross_device_ticket_not_found","message":"Cross device ticket not found"},"key":"CrossDeviceTicketNotFound","summary":"CrossDeviceTicketNotFound","description":"When the ticketId doesn't exist","id":"paths/~1v1~1auth~1webauthn~1cross-device~1status/get/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"},"paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/400/content/application~1json/examples/InvalidRequest":{"value":{"error_code":"invalid_request","message":"Invalid request: property should not be null or undefined"},"key":"InvalidRequest","summary":"InvalidRequest","id":"paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/400/content/application~1json/examples/InvalidRequest"},"paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound":{"value":{"error_code":"cross_device_ticket_not_found","message":"Cross device ticket not found"},"key":"CrossDeviceTicketNotFound","summary":"CrossDeviceTicketNotFound","description":"When the ticketId doesn't exist","id":"paths/~1v1~1auth~1webauthn~1cross-device~1attach-device/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"},"paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/400/content/application~1json/examples/InvalidRequest":{"value":{"error_code":"invalid_request","message":"Invalid request: property should not be null or undefined"},"key":"InvalidRequest","summary":"InvalidRequest","id":"paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/400/content/application~1json/examples/InvalidRequest"},"paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/404/content/application~1json/examples/ClientNotFound":{"value":{"error_code":"client_not_found","message":"Client not found"},"key":"ClientNotFound","summary":"ClientNotFound","description":"When the clientId doesn't exist","id":"paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1init/post/responses/404/content/application~1json/examples/ClientNotFound"},"paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/400/content/application~1json/examples/InvalidRequest":{"value":{"error_code":"invalid_request","message":"Invalid request: property should not be null or undefined"},"key":"InvalidRequest","summary":"InvalidRequest","id":"paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/400/content/application~1json/examples/InvalidRequest"},"paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound":{"value":{"error_code":"cross_device_ticket_not_found","message":"Cross device ticket not found"},"key":"CrossDeviceTicketNotFound","summary":"CrossDeviceTicketNotFound","description":"When the ticketId doesn't exist","id":"paths/~1v1~1auth~1webauthn~1cross-device~1authenticate~1start/post/responses/404/content/application~1json/examples/CrossDeviceTicketNotFound"}},"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"}],"specType":"openapi"},"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":""}},"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/user/backend-webauthn-cross-device.openapi.json?download"},{"url":"/_bundle/openapi/user/backend-webauthn-cross-device.openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"WebAuthn Cross-Device","description":"APIs to manage cross-device flow for WebAuthn registration and authentication."}},"baseSlug":"/openapi/user/backend-webauthn-cross-device.openapi","routesMapping":{}}