{"items":[{"type":"link","label":"Social Login","link":"/openapi/user/backend-social-login.openapi","routeSlug":"/openapi/user/backend-social-login.openapi","content":{"contentType":"overview","meta":{"name":"Social Login"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"backend-social-login.openapi.json","url":"/_bundle/openapi/user/backend-social-login.openapi.json?download"},{"kind":"download","label":"backend-social-login.openapi.yaml","url":"/_bundle/openapi/user/backend-social-login.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":"Social Login","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Login users using social login providers like Google Sign-In. This implements a backend-to-backend integration for authentication. Irrespective of the social login provider, the flow includes three steps: initiating a login, submitting the received code to Mosaic, and finally completing authentication with Mosaic."}],"sectionId":"/openapi/user/backend-social-login.openapi"}],"sectionId":"/openapi/user/backend-social-login.openapi"}]}]}},{"label":"Start login with Google","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/initgooglelogin","routeSlug":"/openapi/user/backend-social-login.openapi/other/initgooglelogin","metadata":{"seo":{"title":"Start login with Google","description":"Starts the Google login flow. This call returns an authorization URL to redirect the user to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initGoogleLogin","name":"Start login with Google","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1google~1start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start login with Google","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts the Google login flow. This call returns an authorization URL to redirect the user to."},{"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/ApiSocialInitRequestDto"}},"schemaId":"components/schemas/ApiSocialInitRequestDto","pointer":"/paths/~1v1~1auth~1social~1google~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/google/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":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSocialInitRequestDto"}},"responseCodes":["200"],"pointer":"/v1/auth/social/google/start","href":"other/initgooglelogin","openApiOperationId":"initGoogleLogin","summary":"Start login with Google"},"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/ApiSocialInitRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialInitRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Backend auth initialized successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSocialInitResponseDto"}},"schemaId":"components/schemas/ApiSocialInitResponseDto"}],"pointer":"/paths/~1v1~1auth~1social~1google~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiSocialInitResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSocialInitResponseDto"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/google/start"},{"label":"Complete login with Google","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/authenticategooglelogin","routeSlug":"/openapi/user/backend-social-login.openapi/other/authenticategooglelogin","metadata":{"seo":{"title":"Complete login with Google","description":"Completes the Google social login flow and authenticates the user in Mosaic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticateGoogleLogin","name":"Complete login with Google","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1google~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete login with Google","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completes the Google social login flow and authenticates the user in Mosaic."},{"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/ApiSocialTokenRequestDto"}},"schemaId":"components/schemas/ApiSocialTokenRequestDto","pointer":"/paths/~1v1~1auth~1social~1google~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/google/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/ApiSocialTokenRequestDto"}},"responseCodes":["200"],"pointer":"/v1/auth/social/google/authenticate","href":"other/authenticategooglelogin","openApiOperationId":"authenticateGoogleLogin","summary":"Complete login with Google"},"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/ApiSocialTokenRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialTokenRequestDto"}},"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"}],"pointer":"/paths/~1v1~1auth~1social~1google~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"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/google/authenticate"},{"label":"Start login with Facebook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/initfacebooklogin","routeSlug":"/openapi/user/backend-social-login.openapi/other/initfacebooklogin","metadata":{"seo":{"title":"Start login with Facebook","description":"Starts the Facebook login flow. This call returns an authorization URL to redirect the user to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initFacebookLogin","name":"Start login with Facebook","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1facebook~1start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start login with Facebook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts the Facebook login flow. This call returns an authorization URL to redirect the user to."},{"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/ApiSocialInitRequestDto"}},"schemaId":"components/schemas/ApiSocialInitRequestDto","pointer":"/paths/~1v1~1auth~1social~1facebook~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/facebook/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":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSocialInitRequestDto"}},"responseCodes":["200"],"pointer":"/v1/auth/social/facebook/start","href":"other/initfacebooklogin","openApiOperationId":"initFacebookLogin","summary":"Start login with Facebook"},"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/ApiSocialInitRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialInitRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Backend auth initialized successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSocialInitResponseDto"}},"schemaId":"components/schemas/ApiSocialInitResponseDto"}],"pointer":"/paths/~1v1~1auth~1social~1facebook~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiSocialInitResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSocialInitResponseDto"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/facebook/start"},{"label":"Complete login with Facebook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/authenticatefacebooklogin","routeSlug":"/openapi/user/backend-social-login.openapi/other/authenticatefacebooklogin","metadata":{"seo":{"title":"Complete login with Facebook","description":"Completes the Facebook social login flow and authenticates the user in Mosaic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticateFacebookLogin","name":"Complete login with Facebook","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1facebook~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete login with Facebook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completes the Facebook social login flow and authenticates the user in Mosaic."},{"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/ApiSocialTokenRequestDto"}},"schemaId":"components/schemas/ApiSocialTokenRequestDto","pointer":"/paths/~1v1~1auth~1social~1facebook~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/facebook/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/ApiSocialTokenRequestDto"}},"responseCodes":["200"],"pointer":"/v1/auth/social/facebook/authenticate","href":"other/authenticatefacebooklogin","openApiOperationId":"authenticateFacebookLogin","summary":"Complete login with Facebook"},"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/ApiSocialTokenRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialTokenRequestDto"}},"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"}],"pointer":"/paths/~1v1~1auth~1social~1facebook~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"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/facebook/authenticate"},{"label":"Start login with Apple","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/initapplelogin","routeSlug":"/openapi/user/backend-social-login.openapi/other/initapplelogin","metadata":{"seo":{"title":"Start login with Apple","description":"Starts the Apple login flow. This call returns an authorization URL to redirect the user to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initAppleLogin","name":"Start login with Apple","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1apple~1start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start login with Apple","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts the Apple login flow. This call returns an authorization URL to redirect the user to."},{"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/ApiSocialInitRequestDto"}},"schemaId":"components/schemas/ApiSocialInitRequestDto","pointer":"/paths/~1v1~1auth~1social~1apple~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/apple/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":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSocialInitRequestDto"}},"responseCodes":["200"],"pointer":"/v1/auth/social/apple/start","href":"other/initapplelogin","openApiOperationId":"initAppleLogin","summary":"Start login with Apple"},"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/ApiSocialInitRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialInitRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Backend auth initialized successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSocialInitResponseDto"}},"schemaId":"components/schemas/ApiSocialInitResponseDto"}],"pointer":"/paths/~1v1~1auth~1social~1apple~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiSocialInitResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSocialInitResponseDto"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/apple/start"},{"label":"Complete login with Apple","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/authenticateapplelogin","routeSlug":"/openapi/user/backend-social-login.openapi/other/authenticateapplelogin","metadata":{"seo":{"title":"Complete login with Apple","description":"Completes the Apple social login flow and authenticates the user in Mosaic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticateAppleLogin","name":"Complete login with Apple","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1apple~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete login with Apple","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completes the Apple social login flow and authenticates the user in Mosaic."},{"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/ApiSocialTokenRequestDto"}},"schemaId":"components/schemas/ApiSocialTokenRequestDto","pointer":"/paths/~1v1~1auth~1social~1apple~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/apple/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/ApiSocialTokenRequestDto"}},"responseCodes":["200"],"pointer":"/v1/auth/social/apple/authenticate","href":"other/authenticateapplelogin","openApiOperationId":"authenticateAppleLogin","summary":"Complete login with Apple"},"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/ApiSocialTokenRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialTokenRequestDto"}},"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"}],"pointer":"/paths/~1v1~1auth~1social~1apple~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"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/apple/authenticate"},{"label":"Start login with Tiktok","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/inittiktoklogin","routeSlug":"/openapi/user/backend-social-login.openapi/other/inittiktoklogin","metadata":{"seo":{"title":"Start login with Tiktok","description":"Starts the Tiktok login flow. This call returns an authorization URL to redirect the user to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initTiktokLogin","name":"Start login with Tiktok","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1tiktok~1start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start login with Tiktok","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts the Tiktok login flow. This call returns an authorization URL to redirect the user to."},{"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/ApiSocialInitRequestDto"}},"schemaId":"components/schemas/ApiSocialInitRequestDto","pointer":"/paths/~1v1~1auth~1social~1tiktok~1start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/tiktok/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":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSocialInitRequestDto"}},"responseCodes":["200"],"pointer":"/v1/auth/social/tiktok/start","href":"other/inittiktoklogin","openApiOperationId":"initTiktokLogin","summary":"Start login with Tiktok"},"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/ApiSocialInitRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialInitRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Backend auth initialized successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSocialInitResponseDto"}},"schemaId":"components/schemas/ApiSocialInitResponseDto"}],"pointer":"/paths/~1v1~1auth~1social~1tiktok~1start/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiSocialInitResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiSocialInitResponseDto"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/tiktok/start"},{"label":"Complete login with Tiktok","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/authenticatetiktoklogin","routeSlug":"/openapi/user/backend-social-login.openapi/other/authenticatetiktoklogin","metadata":{"seo":{"title":"Complete login with Tiktok","description":"Completes the Tiktok social login flow and authenticates the user in Mosaic."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authenticateTiktokLogin","name":"Complete login with Tiktok","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1tiktok~1authenticate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete login with Tiktok","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completes the Tiktok social login flow and authenticates the user in Mosaic."},{"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/ApiSocialTokenRequestDto"}},"schemaId":"components/schemas/ApiSocialTokenRequestDto","pointer":"/paths/~1v1~1auth~1social~1tiktok~1authenticate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/tiktok/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/ApiSocialTokenRequestDto"}},"responseCodes":["200"],"pointer":"/v1/auth/social/tiktok/authenticate","href":"other/authenticatetiktoklogin","openApiOperationId":"authenticateTiktokLogin","summary":"Complete login with Tiktok"},"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/ApiSocialTokenRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialTokenRequestDto"}},"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"}],"pointer":"/paths/~1v1~1auth~1social~1tiktok~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"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/tiktok/authenticate"},{"label":"Submit all callback params from Google","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/verifygooglecallback","routeSlug":"/openapi/user/backend-social-login.openapi/other/verifygooglecallback","metadata":{"seo":{"title":"Submit all callback params from Google","description":"Submits all parameters received from the Google callback to exchange for user identity information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyGoogleCallback","name":"Submit all callback params from Google","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1google~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit all callback params from Google","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits all parameters received from the Google callback to exchange for user identity information"},{"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/ApiSocialValidateRequest"}},"schemaId":"components/schemas/ApiSocialValidateRequest","pointer":"/paths/~1v1~1auth~1social~1google~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/google/validate","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSocialValidateRequest"}},"responseCodes":["200"],"pointer":"/v1/auth/social/google/validate","href":"other/verifygooglecallback","openApiOperationId":"verifyGoogleCallback","summary":"Submit all callback params from Google"},"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/ApiSocialValidateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialValidateRequest"}},"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 claims and transaction ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGoogleVerifyResponse"}},"schemaId":"components/schemas/ApiGoogleVerifyResponse"}],"pointer":"/paths/~1v1~1auth~1social~1google~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGoogleVerifyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGoogleVerifyResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/google/validate"},{"label":"Submit all callback params from Facebook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/verifyfacebookcallback","routeSlug":"/openapi/user/backend-social-login.openapi/other/verifyfacebookcallback","metadata":{"seo":{"title":"Submit all callback params from Facebook","description":"Submits all parameters received from the Facebook callback to exchange for user identity information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyFacebookCallback","name":"Submit all callback params from Facebook","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1facebook~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit all callback params from Facebook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits all parameters received from the Facebook callback to exchange for user identity information"},{"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/ApiSocialValidateRequest"}},"schemaId":"components/schemas/ApiSocialValidateRequest","pointer":"/paths/~1v1~1auth~1social~1facebook~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/facebook/validate","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSocialValidateRequest"}},"responseCodes":["200"],"pointer":"/v1/auth/social/facebook/validate","href":"other/verifyfacebookcallback","openApiOperationId":"verifyFacebookCallback","summary":"Submit all callback params from Facebook"},"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/ApiSocialValidateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialValidateRequest"}},"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 claims and transaction ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGoogleVerifyResponse"}},"schemaId":"components/schemas/ApiGoogleVerifyResponse"}],"pointer":"/paths/~1v1~1auth~1social~1facebook~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGoogleVerifyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGoogleVerifyResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/facebook/validate"},{"label":"Submit all callback params from Apple","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/verifyapplecallback","routeSlug":"/openapi/user/backend-social-login.openapi/other/verifyapplecallback","metadata":{"seo":{"title":"Submit all callback params from Apple","description":"Submits all parameters received from the Apple callback to exchange for user identity information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyAppleCallback","name":"Submit all callback params from Apple","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1apple~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit all callback params from Apple","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits all parameters received from the Apple callback to exchange for user identity information"},{"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/ApiSocialValidateRequest"}},"schemaId":"components/schemas/ApiSocialValidateRequest","pointer":"/paths/~1v1~1auth~1social~1apple~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/apple/validate","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSocialValidateRequest"}},"responseCodes":["200"],"pointer":"/v1/auth/social/apple/validate","href":"other/verifyapplecallback","openApiOperationId":"verifyAppleCallback","summary":"Submit all callback params from Apple"},"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/ApiSocialValidateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialValidateRequest"}},"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 claims and transaction ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGoogleVerifyResponse"}},"schemaId":"components/schemas/ApiGoogleVerifyResponse"}],"pointer":"/paths/~1v1~1auth~1social~1apple~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGoogleVerifyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGoogleVerifyResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/apple/validate"},{"label":"Submit all callback params from TikTok","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/backend-social-login.openapi/other/verifytiktokcallback","routeSlug":"/openapi/user/backend-social-login.openapi/other/verifytiktokcallback","metadata":{"seo":{"title":"Submit all callback params from TikTok","description":"Submits all parameters received from the TikTok callback to exchange for user identity information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyTiktokCallback","name":"Submit all callback params from TikTok","isWebhook":false,"pointer":"/paths/~1v1~1auth~1social~1tiktok~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit all callback params from TikTok","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits all parameters received from the TikTok callback to exchange for user identity information"},{"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/ApiSocialValidateRequest"}},"schemaId":"components/schemas/ApiSocialValidateRequest","pointer":"/paths/~1v1~1auth~1social~1tiktok~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/social/tiktok/validate","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientAccessToken","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiSocialValidateRequest"}},"responseCodes":["200"],"pointer":"/v1/auth/social/tiktok/validate","href":"other/verifytiktokcallback","openApiOperationId":"verifyTiktokCallback","summary":"Submit all callback params from TikTok"},"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/ApiSocialValidateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiSocialValidateRequest"}},"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 claims and transaction ID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGoogleVerifyResponse"}},"schemaId":"components/schemas/ApiGoogleVerifyResponse"}],"pointer":"/paths/~1v1~1auth~1social~1tiktok~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiGoogleVerifyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiGoogleVerifyResponse"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/social/tiktok/validate"}],"store":{"schemaStore":{"components/schemas/ApiSocialInitRequestDto":{"id":"components/schemas/ApiSocialInitRequestDto","kind":"json-schema","title":"ApiSocialInitRequestDto","data":{"type":"object","properties":{"device_id":{"type":"string","description":"Identifier of the device from which the authentication request originates","maxLength":80},"redirect_uri":{"type":"string","example":"https://www.example.com/login","description":"The URI the identity provider will redirect the user to after authentication. Must match one of the pre-configured redirect URIs in the application's social login settings. This URI will receive the authorization code that can be exchanged for user information."},"state":{"type":"string","description":"An opaque string that is used to maintain state between the request and the callback. It will be added to the redirect URI as a query parameter, which should be validated by your server to protect against cross-site request forgery (CSRF) attacks"}},"required":["redirect_uri"]}},"components/schemas/ApiSocialInitResponseDto":{"id":"components/schemas/ApiSocialInitResponseDto","kind":"json-schema","title":"ApiSocialInitResponseDto","data":{"type":"object","properties":{"authorization_url":{"type":"string","example":"https://www.provider.com/auth","description":"The social provider's authorization URL that the client should redirect the user to in order to authenticate with this social provider."}},"required":["authorization_url"]}},"components/schemas/ApiSocialTokenRequestDto":{"id":"components/schemas/ApiSocialTokenRequestDto","kind":"json-schema","title":"ApiSocialTokenRequestDto","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":{"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":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/ApiTokenRequestClaims"}]},"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."},"transaction_id":{"type":"string","description":"The transaction identifier that was previously returned by the verification endpoint. This ID is required to associate this authentication request with the verified token information stored during the verification step."},"user_id":{"type":"string","description":"An identifier of the user for whom the token is being requested"}},"required":["transaction_id","user_id"]}},"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/ApiSocialValidateRequest":{"id":"components/schemas/ApiSocialValidateRequest","kind":"json-schema","title":"ApiSocialValidateRequest","data":{"type":"object","properties":{"params":{"type":"object","description":"All parameters received from the social provider callback. Pass through the full query string / POST body from the IdP redirect as-is."}},"required":["params"]}},"components/schemas/ApiGoogleVerifyResponse":{"id":"components/schemas/ApiGoogleVerifyResponse","kind":"json-schema","title":"ApiGoogleVerifyResponse","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier generated during token verification that links this verification process to subsequent authentication requests. This transaction_id must be included in the authentication request to complete the social login flow."},"children":[]}]}]}]},"claims":{"type":"object","description":"An object containing user identity information extracted from the verified social provider token. This includes standard profile details such as name, email, and unique identifiers from the social provider."}},"required":["transaction_id","claims"]}},"components/schemas/ApiFacebookVerifyResponse":{"id":"components/schemas/ApiFacebookVerifyResponse","kind":"json-schema","title":"ApiFacebookVerifyResponse","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier generated during token verification that links this verification process to subsequent authentication requests. This transaction_id must be included in the authentication request to complete the social login flow."},"children":[]}]}]}]},"claims":{"type":"object","description":"An object containing user identity information extracted from the verified social provider token. This includes standard profile details such as name, email, and unique identifiers from the social provider."}},"required":["transaction_id","claims"]}},"components/schemas/ApiAppleVerifyResponse":{"id":"components/schemas/ApiAppleVerifyResponse","kind":"json-schema","title":"ApiAppleVerifyResponse","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier generated during token verification that links this verification process to subsequent authentication requests. This transaction_id must be included in the authentication request to complete the social login flow."},"children":[]}]}]}]},"claims":{"type":"object","description":"An object containing user identity information extracted from the verified social provider token. This includes standard profile details such as name, email, and unique identifiers from the social provider."}},"required":["transaction_id","claims"]}},"components/schemas/ApiTiktokVerifyResponse":{"id":"components/schemas/ApiTiktokVerifyResponse","kind":"json-schema","title":"ApiTiktokVerifyResponse","data":{"type":"object","properties":{"transaction_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier generated during token verification that links this verification process to subsequent authentication requests. This transaction_id must be included in the authentication request to complete the social login flow."},"children":[]}]}]}]},"claims":{"type":"object","description":"An object containing user identity information extracted from the verified social provider token. This includes standard profile details such as name, email, and unique identifiers from the social provider."}},"required":["transaction_id","claims"]}},"components/schemas/ApiTokenRequestClaims":{"id":"components/schemas/ApiTokenRequestClaims","kind":"json-schema","title":"ApiTokenRequestClaims","data":{"type":"object","properties":{"id_token":{"type":"object"},"access_token":{"type":"object"}}}},"components/schemas/ClientAttributes":{"id":"components/schemas/ClientAttributes","kind":"json-schema","title":"ClientAttributes","data":{"type":"object","properties":{"user_agent":{"type":"string"},"ip_address":{"type":"string"}}}}},"exampleStore":{},"securitySchemeStore":{"bearer":{"id":"bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"},"UserAccessToken":{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"},"AdminAccessToken":{"id":"AdminAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by a management application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to all resources for the tenant and its apps"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"ClientAccessToken":{"id":"ClientAccessToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token generated by an end-user application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/token.openapi/other/getaccesstoken"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}},"OrgAdminAccessToken":{"id":"OrgAdminAccessToken","type":"oauth2","description":"A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.","flows":{"clientCredentials":{"tokenUrl":"/oidc/token","scopes":{}}}}},"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSchemaTitles":true,"onlyRequiredInSamples":false,"hideDownloadButtons":false,"codeSamples":{"skipOptionalParameters":false,"languages":[{"lang":"curl","label":"cURL"},{"lang":"Node.js"},{"lang":"Go"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"}]},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/user/backend-social-login.openapi.json?download"},{"url":"/_bundle/openapi/user/backend-social-login.openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Social Login","description":"Login users using social login providers like Google Sign-In. This implements a backend-to-backend integration for authentication. Irrespective of the social login provider, the flow includes three steps: initiating a login, submitting the received code to Mosaic, and finally completing authentication with Mosaic."}},"baseSlug":"/openapi/user/backend-social-login.openapi","routesMapping":{}}