{"items":[{"type":"link","label":"WebAuthn","link":"/openapi/user/backend-webauthn.openapi","routeSlug":"/openapi/user/backend-webauthn.openapi","content":{"contentType":"overview","meta":{"name":"WebAuthn"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"backend-webauthn.openapi.json","url":"/_bundle/openapi/user/backend-webauthn.openapi.json?download"},{"kind":"download","label":"backend-webauthn.openapi.yaml","url":"/_bundle/openapi/user/backend-webauthn.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","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Login users using WebAuthn biometrics integrated into your native login experience. Although WebAuthn authentication and registration is initiated in the frontend, the flows are completed using a backend-to-backend integration. The client-side integration can also be implemented using the Transmit Platform SDK."}],"sectionId":"/openapi/user/backend-webauthn.openapi"}],"sectionId":"/openapi/user/backend-webauthn.openapi"}]}]}},{"label":"Start authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn.openapi/other/authenticationstart","routeSlug":"/openapi/user/backend-webauthn.openapi/other/authenticationstart","metadata":{"seo":{"title":"Start authentication","description":"Start a new WebAuthn authentication. If successful, the response contains a credential_request_options field that should be passed to the WebAuthn navigator.credentials.get() API call. Note that 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":"authenticationStart","name":"Start authentication","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~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":"Start a new WebAuthn authentication. 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. Note that 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":"schema_355"}},"schemaId":"schema_355","pointer":"/paths/~1v1~1auth~1webauthn~1authenticate~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/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":"schema_355"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v1/auth/webauthn/authenticate/start","href":"other/authenticationstart","openApiOperationId":"authenticationStart","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":"schema_355","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_355"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authentication options","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiWebAuthnAuthenticateStartResponse"}},"schemaId":"components/schemas/ApiWebAuthnAuthenticateStartResponse"},{"code":"400","description":"Invalid input or webauthn configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"401","description":"Invalid origin or no credentials registered","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}},"schemaId":"schema_357"},{"code":"404","description":"Client not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358"}},"schemaId":"schema_358"},{"code":"500","description":"Invalid encoded result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/~1v1~1auth~1webauthn~1authenticate~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiWebAuthnAuthenticateStartResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiWebAuthnAuthenticateStartResponse"}}},{"code":"400","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"401","schemaId":"schema_357","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}}},{"code":"404","schemaId":"schema_358","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358"}}},{"code":"500","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/authenticate/start"},{"label":"Authenticate WebAuthn","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn.openapi/other/authenticatewebauthncredential","routeSlug":"/openapi/user/backend-webauthn.openapi/other/authenticatewebauthncredential","metadata":{"seo":{"title":"Authenticate WebAuthn","description":"Authenticate a user using their WebAuthn credentials. Retrieves tokens based on a the encoded result of the webauthn authentication."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticateWebauthnCredential","name":"Authenticate WebAuthn","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticate WebAuthn","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Authenticate a user using their WebAuthn credentials. Retrieves tokens based on a the encoded result of the webauthn authentication."},{"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/ApiWebauthnTokenRequestDto"}},"schemaId":"components/schemas/ApiWebauthnTokenRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/authenticate","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/ApiWebauthnTokenRequestDto"}},"responseCodes":["200","400","500"],"pointer":"/v1/auth/webauthn/authenticate","href":"other/authenticatewebauthncredential","openApiOperationId":"authenticateWebauthnCredential","summary":"Authenticate WebAuthn"},"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/ApiWebauthnTokenRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiWebauthnTokenRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns user tokens","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiTokenResponse"}},"schemaId":"components/schemas/ApiTokenResponse"},{"code":"400","description":"WebAuthn authentication errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}},"schemaId":"schema_360"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"}],"pointer":"/paths/~1v1~1auth~1webauthn~1authenticate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiTokenResponse"}}},{"code":"400","schemaId":"schema_360","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}}},{"code":"500","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/authenticate"},{"label":"Init hosted registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn.openapi/other/hosted-webauthn-registration-hint","routeSlug":"/openapi/user/backend-webauthn.openapi/other/hosted-webauthn-registration-hint","metadata":{"seo":{"title":"Init hosted registration","description":"Initializes a hosted WebAuthn registration flow for a logged-out user (see Quickstart). This API is used to securely set the WebAuthn username in the backend, and returns a registration token used to start the registration flow. Relevant only for hosted login scenarios"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"hosted-webauthn-registration-hint","name":"Init hosted registration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1external~1register~1hosted~1hint/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Init hosted 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 hosted WebAuthn registration flow for a logged-out user (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/user/auth_webauthn_registr_quickstart/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quickstart"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This API is used to securely set the WebAuthn username in the backend, and returns a registration token used to start the registration flow. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relevant only for hosted login scenarios"},"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/WebauthnExternalRegisterHintRequestDto"}},"schemaId":"components/schemas/WebauthnExternalRegisterHintRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1external~1register~1hosted~1hint/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/external/register/hosted/hint","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/WebauthnExternalRegisterHintRequestDto"}},"responseCodes":["200","400","404"],"pointer":"/v1/auth/webauthn/external/register/hosted/hint","href":"other/hosted-webauthn-registration-hint","openApiOperationId":"hosted-webauthn-registration-hint","summary":"Init hosted 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/WebauthnExternalRegisterHintRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebauthnExternalRegisterHintRequestDto"}},"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/WebauthnExternalRegisterHintResponseDto"}},"schemaId":"components/schemas/WebauthnExternalRegisterHintResponseDto"},{"code":"400","description":"Unknown identifier type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361"}},"schemaId":"schema_361"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1external~1register~1hosted~1hint/post/responses/404/content/application~1json/examples/ClientNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1external~1register~1hosted~1hint/post/responses/404/content/application~1json/examples/ClientNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1external~1register~1hosted~1hint/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebauthnExternalRegisterHintResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebauthnExternalRegisterHintResponseDto"}}},{"code":"400","schemaId":"schema_361","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361"}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1external~1register~1hosted~1hint/post/responses/404/content/application~1json/examples/ClientNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1external~1register~1hosted~1hint/post/responses/404/content/application~1json/examples/ClientNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/external/register/hosted/hint"},{"label":"Start registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn.openapi/other/webauthn-registration-start","routeSlug":"/openapi/user/backend-webauthn.openapi/other/webauthn-registration-start","metadata":{"seo":{"title":"Start registration","description":"Starts a registration of WebAuthn credentials for a specified user, returning a challenge to be signed by the client. If successful, the response contains a credential_creation_options field that should be passed to the WebAuthn navigator.credentials.create() API call. Note that 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-registration-start","name":"Start registration","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~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 registration of WebAuthn credentials for a specified user, returning a challenge to be signed by the client. 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. Note that 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/WebauthnRegisterStartRequestDto"}},"schemaId":"components/schemas/WebauthnRegisterStartRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1register~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/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/WebauthnRegisterStartRequestDto"}},"responseCodes":["200","400","401","404"],"pointer":"/v1/auth/webauthn/register/start","href":"other/webauthn-registration-start","openApiOperationId":"webauthn-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/WebauthnRegisterStartRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterStartRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Active WebAuthn session info","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterStartResponseDto"}},"schemaId":"components/schemas/WebauthnRegisterStartResponseDto"},{"code":"400","description":"Invalid input or webauthn configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"401","description":"Invalid origin","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362"},{"code":"404","description":"Client not found or authentication not registered","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363"}],"pointer":"/paths/~1v1~1auth~1webauthn~1register~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebauthnRegisterStartResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterStartResponseDto"}}},{"code":"400","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"401","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}},{"code":"404","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/register/start"},{"label":"Register for logged-in user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn.openapi/other/webauthn-registration","routeSlug":"/openapi/user/backend-webauthn.openapi/other/webauthn-registration","metadata":{"seo":{"title":"Register for logged-in user","description":"Complete WebAuthn credential registration for a user that is currently logged in using a different Transmit authentication method. This API must be called from the backend using the user access token returned upon successful authentication. If successful, the credential will be registered for the user that corresponds to the authorization token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-registration","name":"Register for logged-in user","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1register/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register for logged-in user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Complete WebAuthn credential registration for a user that is currently logged in using a different Transmit authentication method. This API must be called from the backend using the user access token returned upon successful authentication. If successful, the credential will be registered for the user that corresponds to the authorization token."},{"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/WebauthnRegisterCompleteRequestDto"}},"schemaId":"components/schemas/WebauthnRegisterCompleteRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1register/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/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":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterCompleteRequestDto"}},"responseCodes":["200","400","401","404"],"pointer":"/v1/auth/webauthn/register","href":"other/webauthn-registration","openApiOperationId":"webauthn-registration","summary":"Register for logged-in user"},"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/WebauthnRegisterCompleteResponseDto"}},"schemaId":"components/schemas/WebauthnRegisterCompleteResponseDto"},{"code":"400","description":"Invalid encoded result, client ID mismatch, or credential name already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}},"schemaId":"schema_364"},{"code":"401","description":"Invalid origin or credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}},"schemaId":"schema_365"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1register/post/responses/404/content/application~1json/examples/ClientNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1register/post/responses/404/content/application~1json/examples/ClientNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1register/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebauthnRegisterCompleteResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterCompleteResponseDto"}}},{"code":"400","schemaId":"schema_364","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}}},{"code":"401","schemaId":"schema_365","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1register/post/responses/404/content/application~1json/examples/ClientNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1register/post/responses/404/content/application~1json/examples/ClientNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/register"},{"label":"Register for logged-out user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-webauthn.openapi/other/webauthn-registration-external","routeSlug":"/openapi/user/backend-webauthn.openapi/other/webauthn-registration-external","metadata":{"seo":{"title":"Register for logged-out user","description":"Complete WebAuthn credential registration for a new user (in Transmit) or a user that isn't currently logged in via Transmit. This API must be called from the backend using a client access token. If successful, the credentials will be registered for the user corresponding to the external user ID in the request. If no user is found, a new user will be created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webauthn-registration-external","name":"Register for logged-out user","isWebhook":false,"pointer":"/paths/~1v1~1auth~1webauthn~1external~1register/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register for logged-out user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Complete WebAuthn credential registration for a new user (in Transmit) or a user that isn't currently logged in via Transmit. This API must be called from the backend using a client access token. If successful, the credentials will be registered for the user corresponding to the external user ID in the request. If no user is found, a new user will be created."},{"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/WebauthnRegisterCompleteExternalRequestDto"}},"schemaId":"components/schemas/WebauthnRegisterCompleteExternalRequestDto","pointer":"/paths/~1v1~1auth~1webauthn~1external~1register/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/webauthn/external/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/WebauthnRegisterCompleteExternalRequestDto"}},"responseCodes":["200","400","401","404"],"pointer":"/v1/auth/webauthn/external/register","href":"other/webauthn-registration-external","openApiOperationId":"webauthn-registration-external","summary":"Register for logged-out user"},"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/WebauthnRegisterCompleteExternalRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterCompleteExternalRequestDto"}},"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","description":"Invalid encoded result, missing external user ID, client ID mismatch, or credential name already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"401","description":"Invalid session, origin not allowed, invalid credentials, or invalid register token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1external~1register/post/responses/404/content/application~1json/examples/ClientNotFound"]}},"exampleIds":["paths/~1v1~1auth~1webauthn~1external~1register/post/responses/404/content/application~1json/examples/ClientNotFound"]}],"pointer":"/paths/~1v1~1auth~1webauthn~1external~1register/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebauthnRegisterCompleteExternalResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebauthnRegisterCompleteExternalResponseDto"}}},{"code":"400","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"401","schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}}},{"code":"404","exampleIds":["paths/~1v1~1auth~1webauthn~1external~1register/post/responses/404/content/application~1json/examples/ClientNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1auth~1webauthn~1external~1register/post/responses/404/content/application~1json/examples/ClientNotFound"]}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/webauthn/external/register"}],"store":{"schemaStore":{"components/schemas/ApiWebauthnTokenRequestDto":{"id":"components/schemas/ApiWebauthnTokenRequestDto","kind":"json-schema","title":"ApiWebauthnTokenRequestDto","data":{"type":"object","properties":{"resource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource URI the authentication request is attempting to access, which is reflected in the audience ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim) of the access token. This must be configured as resource for the application."},"children":[]}]}]}]},"claims":{"type":"object","example":{"id_token":{"roles":null}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to request additional claims in the ID token, such as roles, permissions, and other user profile data. The structure is per the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OIDC Standard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For supported claims and how to request custom claims, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.transmitsecurity.com/openapi/id_token_reference/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID Token Reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"org_id":{"type":"string","description":"Organization ID, used for member login in B2B scenarios"},"client_attributes":{"description":"Client attributes","allOf":[{"$ref":"#/components/schemas/ClientAttributes"}]},"device_id":{"type":"string","description":"Identifier of the device from which the authentication request originates","maxLength":80},"session_id":{"type":"string","description":"Used to associate the authentication with an existing session (such as for MFA). If unspecified, a new session is created and the session ID is returned."},"webauthn_encoded_result":{"type":"string","description":"WebAuthn assertion data (base64 encoded)"}},"required":["webauthn_encoded_result"]}},"components/schemas/ApiTokenResponse":{"id":"components/schemas/ApiTokenResponse","kind":"json-schema","title":"ApiTokenResponse","data":{"type":"object","properties":{"access_token":{"type":"string","description":"User access token for accessing endpoints on behalf of the authenticated user."},"id_token":{"type":"string","description":"ID token that identifies the user."},"refresh_token":{"type":"string","description":"Refresh token used to refresh an expired access token."},"token_type":{"type":"string","description":"Bearer."},"expires_in":{"type":"number","description":"Expiration time of the access token in seconds.","default":3600},"session_id":{"type":"string","description":"ID of the session in which the authentication occurs."},"signing_artifacts":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cryptographic data required to independently verify a transaction approval outside Mosaic. Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approval_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided for a supported transaction-signing flow; fields vary by authenticator."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/ApiPasskeySigningArtifactsDto"},{"$ref":"#/components/schemas/ApiCryptoKeySigningArtifactsDto"}]}},"required":["access_token","token_type","expires_in","session_id"]}},"components/schemas/ApiPasskeySigningArtifactsDto":{"id":"components/schemas/ApiPasskeySigningArtifactsDto","kind":"json-schema","title":"ApiPasskeySigningArtifactsDto","data":{"type":"object","properties":{"approval_data":{"type":"object","additionalProperties":{"type":"string"},"description":"Transaction data provided when the transaction-signing flow was started. Returned after a successful approval.","example":{"transaction_id":"eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT","sum":"200"}},"public_key":{"type":"string","description":"Public key used to verify the signature."},"signature":{"type":"string","description":"Signature generated by the passkey authenticator."},"credential_id":{"type":"string","description":"Identifier of the passkey credential used for the approval."},"webauthn_session_id":{"type":"string","description":"Identifier of the WebAuthn authentication session."},"authenticator_data":{"type":"string","description":"Base64url-encoded data returned by the passkey authenticator as part of the WebAuthn assertion."},"client_data_json":{"type":"string","description":"Base64url-encoded client data from the WebAuthn authentication response."},"raw_challenge":{"type":"string","description":"Raw pre-hash challenge used to bind the signature to the approval data."}},"required":["approval_data","public_key","signature","credential_id","webauthn_session_id","authenticator_data","client_data_json","raw_challenge"]}},"components/schemas/ApiSigningArtifactAlgorithmDto":{"id":"components/schemas/ApiSigningArtifactAlgorithmDto","kind":"json-schema","title":"ApiSigningArtifactAlgorithmDto","data":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature algorithm used to verify the signature, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ecdsa"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rsa-pss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"hash":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hash algorithm used to verify the signature, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sha-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"saltLength":{"type":"number","description":"Length, in bytes, of the salt used by RSA-PSS."},"namedCurve":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Elliptic curve used by ECDSA, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P-256"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["name"]}},"components/schemas/ApiCryptoKeySigningArtifactsDto":{"id":"components/schemas/ApiCryptoKeySigningArtifactsDto","kind":"json-schema","title":"ApiCryptoKeySigningArtifactsDto","data":{"type":"object","properties":{"approval_data":{"type":"object","additionalProperties":{"type":"string"},"description":"Transaction data provided when the transaction-signing flow was started. Returned after a successful approval.","example":{"transaction_id":"eFII2y40uB9hQ98nXt3tc1IHkRt8GrRZiqZuRn_59wT","sum":"200"}},"public_key":{"type":"string","description":"Public key used to verify the signature."},"signature":{"type":"string","description":"Signature generated for the transaction-signing challenge."},"challenge":{"type":"string","description":"Challenge used to generate the signature and bind it to the approval data."},"algorithm":{"description":"Parameters required to verify the signature.","allOf":[{"$ref":"#/components/schemas/ApiSigningArtifactAlgorithmDto"}]}},"required":["approval_data","public_key","signature","challenge","algorithm"]}},"components/schemas/ClientAttributes":{"id":"components/schemas/ClientAttributes","kind":"json-schema","title":"ClientAttributes","data":{"type":"object","properties":{"user_agent":{"type":"string"},"ip_address":{"type":"string"}}}},"components/schemas/WebauthnRegisterCompleteExternalRequestDto":{"id":"components/schemas/WebauthnRegisterCompleteExternalRequestDto","kind":"json-schema","title":"WebauthnRegisterCompleteExternalRequestDto","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."},"external_user_id":{"type":"string","description":"A unique identifier in the tenant, which corresponds to an identifier of the user in your system."},"user_email":{"type":"string","description":"The user's primary email address"}},"required":["webauthn_encoded_result","external_user_id"]}},"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/WebauthnExternalRegisterHintRequestDto":{"id":"components/schemas/WebauthnExternalRegisterHintRequestDto","kind":"json-schema","title":"WebauthnExternalRegisterHintRequestDto","data":{"type":"object","properties":{"webauthn_identifier":{"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.","maxLength":64,"minLength":1},"webauthn_display_name":{"type":"string","description":"Human-palatable name for the user account, only for display (max 64 characters).  If not set, the username parameter will also act as the display name","maxLength":64,"minLength":1},"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},"redirect_uri":{"type":"string","description":"URI to redirect to upon completing the registration process"}},"required":["webauthn_identifier","redirect_uri"]}},"components/schemas/WebauthnExternalRegisterHintResponseDto":{"id":"components/schemas/WebauthnExternalRegisterHintResponseDto","kind":"json-schema","title":"WebauthnExternalRegisterHintResponseDto","data":{"type":"object","properties":{"register_webauthn_cred_token":{"type":"string","description":"Token returned to relying party to ensure the specified username is being used for webauthn credential registration"}},"required":["register_webauthn_cred_token"]}},"components/schemas/WebauthnRegisterStartRequestDto":{"id":"components/schemas/WebauthnRegisterStartRequestDto","kind":"json-schema","title":"WebauthnRegisterStartRequestDto","data":{"type":"object","properties":{"client_id":{"type":"string","description":"Your client ID."},"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.","maxLength":64,"minLength":1},"display_name":{"type":"string","description":"Human-palatable name for the user account, only for display (max 64 characters).  If not set, the username parameter will also act as the display name","maxLength":64,"minLength":1},"timeout":{"type":"number","description":"The timeout in seconds for the registration modal. \n    Must be between 30 and 600. \n    Default is 300 seconds."},"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":["client_id","username"]}},"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/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/WebauthnRegisterCompleteResponseDto":{"id":"components/schemas/WebauthnRegisterCompleteResponseDto","kind":"json-schema","title":"WebauthnRegisterCompleteResponseDto","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"}},"required":["webauthn_session_id","webauthn_username","credential_id","authenticator_attachment"]}},"components/schemas/ApiWebAuthnAuthenticateStartWithIdentifierRequestDto":{"id":"components/schemas/ApiWebAuthnAuthenticateStartWithIdentifierRequestDto","kind":"json-schema","title":"ApiWebAuthnAuthenticateStartWithIdentifierRequestDto","data":{"type":"object","properties":{"client_id":{"type":"string","description":"The client ID of the application the user is trying to authenticate to."},"timeout":{"type":"number","description":"The timeout in seconds for the authentication modal. \n    Must be between 30 and 600. \n    Default is 300 seconds."},"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."},"identifier":{"type":"string","example":"name@example.com","description":"Identifier value (email, phone number, user ID, or custom identifier)"},"identifier_type":{"type":"string","example":"email","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of identifier (email, phone_number, user_id, username, or custom identifier type)"},"children":[]}]}]}]}},"required":["client_id","identifier","identifier_type"]}},"components/schemas/ApiWebAuthnAuthenticateStartWithUsernameRequestDto":{"id":"components/schemas/ApiWebAuthnAuthenticateStartWithUsernameRequestDto","kind":"json-schema","title":"ApiWebAuthnAuthenticateStartWithUsernameRequestDto","data":{"type":"object","properties":{"client_id":{"type":"string","description":"The client ID of the application the user is trying to authenticate to."},"timeout":{"type":"number","description":"The timeout in seconds for the authentication modal. \n    Must be between 30 and 600. \n    Default is 300 seconds."},"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","maxLength":64,"minLength":1,"deprecated":true},"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/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/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/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/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/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"]}},"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"]}},"schema_355":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ApiWebAuthnAuthenticateStartWithIdentifierRequestDto"},{"$ref":"#/components/schemas/ApiWebAuthnAuthenticateStartWithUsernameRequestDto"}]},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["system_invalid_input","auth_webauthn_invalid_webauthn_config"]},"message":{"type":"string"}}},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_webauthn_invalid_origin_error","auth_not_registered"]},"message":{"type":"string"}}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["client_not_exist"]},"message":{"type":"string"}}},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_webauthn_invalid_encoded_result"]},"message":{"type":"string"}}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["user_not_found","client_not_exist","auth_webauthn_invalid_encoded_result","auth_locked"]},"message":{"type":"string"}}},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["user_unknown_identifier_type"]},"message":{"type":"string"}}},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_webauthn_invalid_origin_error"]},"message":{"type":"string"}}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["client_not_exist","auth_not_registered"]},"message":{"type":"string"}}},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_webauthn_invalid_encoded_result","client_id_mismatch","auth_webauthn_credential_name_already_exists"]},"message":{"type":"string"}}},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_webauthn_invalid_session","auth_webauthn_invalid_origin_error","auth_webauthn_origin_not_allowed","auth_invalid_credentials"]},"message":{"type":"string"}}},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_webauthn_invalid_encoded_result","user_external_user_id_missing","client_id_mismatch","auth_webauthn_credential_name_already_exists"]},"message":{"type":"string"}}},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"type":"object","properties":{"error_code":{"type":"string","enum":["auth_webauthn_invalid_session","auth_webauthn_origin_not_allowed","auth_invalid_credentials","auth_webauthn_invalid_register_cred_token"]},"message":{"type":"string"}}},"id":"schema_367"}},"exampleStore":{"paths/~1v1~1auth~1webauthn~1external~1register~1hosted~1hint/post/responses/404/content/application~1json/examples/ClientNotFound":{"value":{"error_code":"client_not_found","message":"Client not found"},"key":"ClientNotFound","summary":"ClientNotFound","id":"paths/~1v1~1auth~1webauthn~1external~1register~1hosted~1hint/post/responses/404/content/application~1json/examples/ClientNotFound"},"paths/~1v1~1auth~1webauthn~1register/post/responses/404/content/application~1json/examples/ClientNotFound":{"value":{"error_code":"client_not_found","message":"Client not found"},"key":"ClientNotFound","summary":"ClientNotFound","id":"paths/~1v1~1auth~1webauthn~1register/post/responses/404/content/application~1json/examples/ClientNotFound"},"paths/~1v1~1auth~1webauthn~1external~1register/post/responses/404/content/application~1json/examples/ClientNotFound":{"value":{"error_code":"client_not_found","message":"Client not found"},"key":"ClientNotFound","summary":"ClientNotFound","id":"paths/~1v1~1auth~1webauthn~1external~1register/post/responses/404/content/application~1json/examples/ClientNotFound"}},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},"UserAccessToken":{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"},"AdminAccessToken":{"id":"AdminAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"ClientAccessToken":{"id":"ClientAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"OrgAdminAccessToken":{"id":"OrgAdminAccessToken","type":"oauth2","description":"A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}},"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSchemaTitles":true,"onlyRequiredInSamples":false,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":false,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/user/backend-webauthn.openapi.json?download"},{"url":"/_bundle/openapi/user/backend-webauthn.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"WebAuthn","description":"Login users using WebAuthn biometrics integrated into your native login experience. Although WebAuthn authentication and registration is initiated in the frontend, the flows are completed using a backend-to-backend integration. The client-side integration can also be implemented using the Transmit Platform SDK."}},"baseSlug":"/openapi/user/backend-webauthn.openapi","routesMapping":{}}