{"items":[{"type":"link","label":"Social Login","link":"/openapi/user/social-login.openapi","routeSlug":"/openapi/user/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":"social-login.openapi.json","url":"/_bundle/openapi/user/social-login.openapi.json?download"},{"kind":"download","label":"social-login.openapi.yaml","url":"/_bundle/openapi/user/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 frontend integration for authentication, where the client obtains an authorization code that your app can exchange in the backend for user tokens."}],"sectionId":"/openapi/user/social-login.openapi"}],"sectionId":"/openapi/user/social-login.openapi"}]}]}},{"label":"Login with Google","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/social-login.openapi/other/startgoogleflow","routeSlug":"/openapi/user/social-login.openapi/other/startgoogleflow","metadata":{"seo":{"title":"Login with Google","description":"Authenticate the user using Google Sign-In. This endpoint should be called from the user's browser. It will redirect the User Agent to the Google IDP and redirect back to Transmit upon successful authentication. Once Transmit verifies the authentication response, the User Agent will be redirected to the redirect_uri specified in the request. This URI will now include a code parameter in the query, which will be later exchanged for a token via the /oidc/token endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startGoogleFlow","name":"Login with Google","isWebhook":false,"pointer":"/paths/~1v1~1auth~1google/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login with Google","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":"Authenticate the user using Google Sign-In. This endpoint should be called from the user's browser. It will redirect the User Agent to the Google IDP and redirect back to Transmit upon successful authentication. Once Transmit verifies the authentication response, the User Agent will be redirected to the redirect_uri specified in the request. This URI will now include a code parameter in the query, which will be later exchanged for a token via the /oidc/token endpoint."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"client_id","in":"query","schemaId":"schema_471","description":"Client ID of the application requesting authentication, retrieved from the Transmit Admin Portal","required":true,"example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV"},{"name":"redirect_uri","in":"query","schemaId":"schema_472","description":"URI to redirect to upon completion of the IDP flow. This is the server GET endpoint used to call the token endpoint, and should accept \"code\" as a query parameter. This URI must also be configured as an allowed redirect URI in the Transmit Admin Portal","required":true,"example":"https://www.example.com/login"},{"name":"create_new_user","in":"query","schemaId":"schema_473","description":"Indicates if a new user should be created if no user with associated email was found. If enabled, public signups must also be configured as allowed for the application.","example":false},{"name":"resource","in":"query","schemaId":"schema_472","description":"Resource URI the login is attempting to access."},{"name":"require_mfa","in":"query","schemaId":"schema_474","description":"Require multi factor authentication for this authentication request.","example":true},{"name":"claims","in":"query","schemaId":"schema_472","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A stringified object used to request additional claims in the ID token, such as roles, permissions, and other user profile data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You should stringify the value."},"children":[]}]}]}],"example":"{\"id_token\":{\"roles\":null}}"},{"name":"state","in":"query","schemaId":"schema_472","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"},{"name":"nonce","in":"query","schemaId":"schema_472","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A random value that is included in the authentication request from the client (e.g. browser) to mitigate replay attacks. It will be added to the id_token and the backend service should only accept id_tokens that include the same nonce value as the one included in the original request"},"children":[]}]}]}]},{"name":"org_id","in":"query","schemaId":"schema_472","description":"Organization ID, used for member login in B2B scenarios"}],"pointer":"/paths/~1v1~1auth~1google/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/auth/google","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[{"name":"client_id","in":"query","required":true,"example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV","schemaId":"schema_471"},{"name":"redirect_uri","in":"query","required":true,"example":"https://www.example.com/login","schemaId":"schema_472"},{"name":"create_new_user","in":"query","required":false,"example":false,"schemaId":"schema_473"},{"name":"resource","in":"query","required":false,"schemaId":"schema_472"},{"name":"require_mfa","in":"query","required":false,"example":true,"schemaId":"schema_474"},{"name":"claims","in":"query","required":false,"example":"{\"id_token\":{\"roles\":null}}","schemaId":"schema_472"},{"name":"state","in":"query","required":false,"schemaId":"schema_472"},{"name":"nonce","in":"query","required":false,"schemaId":"schema_472"},{"name":"org_id","in":"query","required":false,"schemaId":"schema_472"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["302","400"],"pointer":"/v1/auth/google","href":"other/startgoogleflow","openApiOperationId":"startGoogleFlow","summary":"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Redirect with code"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidRedirectUriHttpError"}},"schemaId":"components/schemas/InvalidRedirectUriHttpError"}],"pointer":"/paths/~1v1~1auth~1google/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"400","schemaId":"components/schemas/InvalidRedirectUriHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidRedirectUriHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/google"},{"label":"Login with Apple","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/social-login.openapi/other/startappleauth","routeSlug":"/openapi/user/social-login.openapi/other/startappleauth","metadata":{"seo":{"title":"Login with Apple","description":"Authenticate the user using Sign in with Apple. This endpoint should be called from the user's browser. It will redirect the User Agent to the Apple IDP and redirect back to Transmit upon successful authentication. Once Transmit verifies the authentication response, the User Agent will be redirected to the redirect_uri specified in the request. This URI will now include a code parameter in the query, which will be later exchanged for a token via the /oidc/token endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startAppleAuth","name":"Login with Apple","isWebhook":false,"pointer":"/paths/~1v1~1auth~1apple/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login with Apple","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":"Authenticate the user using Sign in with Apple. This endpoint should be called from the user's browser. It will redirect the User Agent to the Apple IDP and redirect back to Transmit upon successful authentication. Once Transmit verifies the authentication response, the User Agent will be redirected to the redirect_uri specified in the request. This URI will now include a code parameter in the query, which will be later exchanged for a token via the /oidc/token endpoint."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"client_id","in":"query","schemaId":"schema_471","description":"Client ID of the application requesting authentication, retrieved from the Transmit Admin Portal","required":true,"example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV"},{"name":"redirect_uri","in":"query","schemaId":"schema_472","description":"URI to redirect to upon completion of the IDP flow. This is the server GET endpoint used to call the token endpoint, and should accept \"code\" as a query parameter. This URI must also be configured as an allowed redirect URI in the Transmit Admin Portal","required":true,"example":"https://www.example.com/login"},{"name":"create_new_user","in":"query","schemaId":"schema_473","description":"Indicates if a new user should be created if no user with associated email was found. If enabled, public signups must also be configured as allowed for the application.","example":false},{"name":"resource","in":"query","schemaId":"schema_472","description":"Resource URI the login is attempting to access."},{"name":"require_mfa","in":"query","schemaId":"schema_474","description":"Require multi factor authentication for this authentication request.","example":true},{"name":"claims","in":"query","schemaId":"schema_472","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A stringified object used to request additional claims in the ID token, such as roles, permissions, and other user profile data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You should stringify the value."},"children":[]}]}]}],"example":"{\"id_token\":{\"roles\":null}}"},{"name":"state","in":"query","schemaId":"schema_472","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"},{"name":"nonce","in":"query","schemaId":"schema_472","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A random value that is included in the authentication request from the client (e.g. browser) to mitigate replay attacks. It will be added to the id_token and the backend service should only accept id_tokens that include the same nonce value as the one included in the original request"},"children":[]}]}]}]},{"name":"org_id","in":"query","schemaId":"schema_472","description":"Organization ID, used for member login in B2B scenarios"}],"pointer":"/paths/~1v1~1auth~1apple/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/auth/apple","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[{"name":"client_id","in":"query","required":true,"example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV","schemaId":"schema_471"},{"name":"redirect_uri","in":"query","required":true,"example":"https://www.example.com/login","schemaId":"schema_472"},{"name":"create_new_user","in":"query","required":false,"example":false,"schemaId":"schema_473"},{"name":"resource","in":"query","required":false,"schemaId":"schema_472"},{"name":"require_mfa","in":"query","required":false,"example":true,"schemaId":"schema_474"},{"name":"claims","in":"query","required":false,"example":"{\"id_token\":{\"roles\":null}}","schemaId":"schema_472"},{"name":"state","in":"query","required":false,"schemaId":"schema_472"},{"name":"nonce","in":"query","required":false,"schemaId":"schema_472"},{"name":"org_id","in":"query","required":false,"schemaId":"schema_472"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["302","400"],"pointer":"/v1/auth/apple","href":"other/startappleauth","openApiOperationId":"startAppleAuth","summary":"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Redirect with code"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidRedirectUriHttpError"}},"schemaId":"components/schemas/InvalidRedirectUriHttpError"}],"pointer":"/paths/~1v1~1auth~1apple/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"400","schemaId":"components/schemas/InvalidRedirectUriHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidRedirectUriHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/apple"},{"label":"Login with Facebook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/social-login.openapi/other/startfacebookauth","routeSlug":"/openapi/user/social-login.openapi/other/startfacebookauth","metadata":{"seo":{"title":"Login with Facebook","description":"Authenticate the user using Facebook Login. This endpoint should be called from the user's browser. It will redirect the User Agent to the Facebook IDP and redirect back to Transmit upon successful authentication. Once Transmit verifies the authentication response, the User Agent will be redirected to the redirect_uri specified in the request. This URI will now include a code parameter in the query, which will be later exchanged for a token via the /oidc/token endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startFacebookAuth","name":"Login with Facebook","isWebhook":false,"pointer":"/paths/~1v1~1auth~1facebook/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login with Facebook","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":"Authenticate the user using Facebook Login. This endpoint should be called from the user's browser. It will redirect the User Agent to the Facebook IDP and redirect back to Transmit upon successful authentication. Once Transmit verifies the authentication response, the User Agent will be redirected to the redirect_uri specified in the request. This URI will now include a code parameter in the query, which will be later exchanged for a token via the /oidc/token endpoint."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"client_id","in":"query","schemaId":"schema_471","description":"Client ID of the application requesting authentication, retrieved from the Transmit Admin Portal","required":true,"example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV"},{"name":"redirect_uri","in":"query","schemaId":"schema_472","description":"URI to redirect to upon completion of the IDP flow. This is the server GET endpoint used to call the token endpoint, and should accept \"code\" as a query parameter. This URI must also be configured as an allowed redirect URI in the Transmit Admin Portal","required":true,"example":"https://www.example.com/login"},{"name":"create_new_user","in":"query","schemaId":"schema_473","description":"Indicates if a new user should be created if no user with associated email was found. If enabled, public signups must also be configured as allowed for the application.","example":false},{"name":"resource","in":"query","schemaId":"schema_472","description":"Resource URI the login is attempting to access."},{"name":"require_mfa","in":"query","schemaId":"schema_474","description":"Require multi factor authentication for this authentication request.","example":true},{"name":"claims","in":"query","schemaId":"schema_472","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A stringified object used to request additional claims in the ID token, such as roles, permissions, and other user profile data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You should stringify the value."},"children":[]}]}]}],"example":"{\"id_token\":{\"roles\":null}}"},{"name":"state","in":"query","schemaId":"schema_472","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"},{"name":"nonce","in":"query","schemaId":"schema_472","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A random value that is included in the authentication request from the client (e.g. browser) to mitigate replay attacks. It will be added to the id_token and the backend service should only accept id_tokens that include the same nonce value as the one included in the original request"},"children":[]}]}]}]},{"name":"org_id","in":"query","schemaId":"schema_472","description":"Organization ID, used for member login in B2B scenarios"}],"pointer":"/paths/~1v1~1auth~1facebook/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/auth/facebook","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[{"name":"client_id","in":"query","required":true,"example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV","schemaId":"schema_471"},{"name":"redirect_uri","in":"query","required":true,"example":"https://www.example.com/login","schemaId":"schema_472"},{"name":"create_new_user","in":"query","required":false,"example":false,"schemaId":"schema_473"},{"name":"resource","in":"query","required":false,"schemaId":"schema_472"},{"name":"require_mfa","in":"query","required":false,"example":true,"schemaId":"schema_474"},{"name":"claims","in":"query","required":false,"example":"{\"id_token\":{\"roles\":null}}","schemaId":"schema_472"},{"name":"state","in":"query","required":false,"schemaId":"schema_472"},{"name":"nonce","in":"query","required":false,"schemaId":"schema_472"},{"name":"org_id","in":"query","required":false,"schemaId":"schema_472"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["302","400"],"pointer":"/v1/auth/facebook","href":"other/startfacebookauth","openApiOperationId":"startFacebookAuth","summary":"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Redirect with code"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidRedirectUriHttpError"}},"schemaId":"components/schemas/InvalidRedirectUriHttpError"}],"pointer":"/paths/~1v1~1auth~1facebook/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"400","schemaId":"components/schemas/InvalidRedirectUriHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidRedirectUriHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/facebook"},{"label":"Login with LINE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/social-login.openapi/other/startlineauth","routeSlug":"/openapi/user/social-login.openapi/other/startlineauth","metadata":{"seo":{"title":"Login with LINE","description":"Authenticate the user using LINE login. This endpoint should be called from the user's browser. It will redirect the User Agent to the LINE IDP and redirect back to Transmit upon successful authentication. Once Transmit verifies the authentication response, the User Agent will be redirected to the redirect_uri specified in the request. This URI will now include a code parameter in the query, which will be later exchanged for a token via the /oidc/token endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startLineAuth","name":"Login with LINE","isWebhook":false,"pointer":"/paths/~1v1~1auth~1line/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Login with LINE","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":"Authenticate the user using LINE login. This endpoint should be called from the user's browser. It will redirect the User Agent to the LINE IDP and redirect back to Transmit upon successful authentication. Once Transmit verifies the authentication response, the User Agent will be redirected to the redirect_uri specified in the request. This URI will now include a code parameter in the query, which will be later exchanged for a token via the /oidc/token endpoint."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"client_id","in":"query","schemaId":"schema_471","description":"Client ID of the application requesting authentication, retrieved from the Transmit Admin Portal","required":true,"example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV"},{"name":"redirect_uri","in":"query","schemaId":"schema_472","description":"URI to redirect to upon completion of the IDP flow. This is the server GET endpoint used to call the token endpoint, and should accept \"code\" as a query parameter. This URI must also be configured as an allowed redirect URI in the Transmit Admin Portal","required":true,"example":"https://www.example.com/login"},{"name":"create_new_user","in":"query","schemaId":"schema_473","description":"Indicates if a new user should be created if no user with associated email was found. If enabled, public signups must also be configured as allowed for the application.","example":false},{"name":"resource","in":"query","schemaId":"schema_472","description":"Resource URI the login is attempting to access."},{"name":"require_mfa","in":"query","schemaId":"schema_474","description":"Require multi factor authentication for this authentication request.","example":true},{"name":"claims","in":"query","schemaId":"schema_472","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A stringified object used to request additional claims in the ID token, such as roles, permissions, and other user profile data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You should stringify the value."},"children":[]}]}]}],"example":"{\"id_token\":{\"roles\":null}}"},{"name":"state","in":"query","schemaId":"schema_472","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"},{"name":"nonce","in":"query","schemaId":"schema_472","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A random value that is included in the authentication request from the client (e.g. browser) to mitigate replay attacks. It will be added to the id_token and the backend service should only accept id_tokens that include the same nonce value as the one included in the original request"},"children":[]}]}]}]},{"name":"org_id","in":"query","schemaId":"schema_472","description":"Organization ID, used for member login in B2B scenarios"}],"pointer":"/paths/~1v1~1auth~1line/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/auth/line","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[{"name":"client_id","in":"query","required":true,"example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV","schemaId":"schema_471"},{"name":"redirect_uri","in":"query","required":true,"example":"https://www.example.com/login","schemaId":"schema_472"},{"name":"create_new_user","in":"query","required":false,"example":false,"schemaId":"schema_473"},{"name":"resource","in":"query","required":false,"schemaId":"schema_472"},{"name":"require_mfa","in":"query","required":false,"example":true,"schemaId":"schema_474"},{"name":"claims","in":"query","required":false,"example":"{\"id_token\":{\"roles\":null}}","schemaId":"schema_472"},{"name":"state","in":"query","required":false,"schemaId":"schema_472"},{"name":"nonce","in":"query","required":false,"schemaId":"schema_472"},{"name":"org_id","in":"query","required":false,"schemaId":"schema_472"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["302","400"],"pointer":"/v1/auth/line","href":"other/startlineauth","openApiOperationId":"startLineAuth","summary":"Login with LINE"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"302","description":"Redirect with code"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidRedirectUriHttpError"}},"schemaId":"components/schemas/InvalidRedirectUriHttpError"}],"pointer":"/paths/~1v1~1auth~1line/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"302"},{"code":"400","schemaId":"components/schemas/InvalidRedirectUriHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidRedirectUriHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/line"},{"label":"Logout","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/social-login.openapi/other/logout","routeSlug":"/openapi/user/social-login.openapi/other/logout","metadata":{"seo":{"title":"Logout","description":"Logout the user from a specific session. The user and session are derived from the access token used to authorize the request (which was issued based on the authentication that created the session)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"logout","name":"Logout","isWebhook":false,"pointer":"/paths/~1v1~1auth~1logout/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Logout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Logout the user from a specific session. The user and session are derived from the access token used to authorize the request (which was issued based on the authentication that created the session)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"UserAccessToken","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/auth/logout","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"UserAccessToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/auth/logout","href":"other/logout","openApiOperationId":"logout","summary":"Logout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sessions deleted Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiLogoutResponse"}},"schemaId":"components/schemas/ApiLogoutResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestException"}},"schemaId":"components/schemas/BadRequestException"},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenHttpError"}},"schemaId":"components/schemas/InvalidTokenHttpError"}],"pointer":"/paths/~1v1~1auth~1logout/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiLogoutResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiLogoutResponse"}}},{"code":"400","schemaId":"components/schemas/BadRequestException","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestException"}}},{"code":"401","schemaId":"components/schemas/InvalidTokenHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/auth/logout"},{"label":"Exchange code for token","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/social-login.openapi/other/tokenexchange","routeSlug":"/openapi/user/social-login.openapi/other/tokenexchange","metadata":{"seo":{"title":"Exchange code for token","description":"Retrieve ID and access tokens. This API is used to retrieve ID and access tokens using the code that was returned in the redirect URI as a query parameter (for example, when the user clicks a magic link). It may also create a new user if create_new_user was set to true in the send request and no user exists for the email address or phone number (depending on the flow)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tokenExchange","name":"Exchange code for token","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange code for token","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve ID and access tokens. This API is used to retrieve ID and access tokens using the code that was returned in the redirect URI as a query parameter (for example, when the user clicks a magic link). It may also create a new user if create_new_user was set to true in the send request and no user exists for the email address or phone number (depending on the flow)."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiTokenExchangeRequestInput"}},"schemaId":"components/schemas/ApiTokenExchangeRequestInput","pointer":"/paths/~1v1~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/token","servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ApiTokenExchangeRequestInput"}},"responseCodes":["200","400"],"pointer":"/v1/token","href":"other/tokenexchange","openApiOperationId":"tokenExchange","summary":"Exchange code for token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.sbx.transmitsecurity.io/cis","description":"Sandbox environment"},{"url":"https://api.transmitsecurity.io/cis","description":"US production environment"},{"url":"https://api.eu.transmitsecurity.io/cis","description":"EU production environment"},{"url":"https://api.ca.transmitsecurity.io/cis","description":"CA production environment"},{"url":"https://api.au.transmitsecurity.io/cis","description":"AU production environment"},{"url":"https://api.gasne1-ts01.transmitsecurity.io/cis","description":"JP production environment"}],"schemaId":"components/schemas/ApiTokenExchangeRequestInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApiTokenExchangeRequestInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiTokenExchangeResponse"}},"schemaId":"components/schemas/ApiTokenExchangeResponse"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}},"schemaId":"components/schemas/BadRequestHttpError"}],"pointer":"/paths/~1v1~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiTokenExchangeResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiTokenExchangeResponse"}}},{"code":"400","schemaId":"components/schemas/BadRequestHttpError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestHttpError"}}}],"examples":[]}]}]}]},"httpPath":"/v1/token"}],"store":{"schemaStore":{"components/schemas/ApiLogoutResponse":{"id":"components/schemas/ApiLogoutResponse","kind":"json-schema","title":"ApiLogoutResponse","data":{"type":"object","properties":{"sessions_count":{"type":"number","description":"Number of logged out sessions"}},"required":["sessions_count"]}},"components/schemas/BadRequestException":{"id":"components/schemas/BadRequestException","kind":"json-schema","title":"BadRequestException","data":{"type":"object","properties":{}}},"components/schemas/InvalidTokenHttpError":{"id":"components/schemas/InvalidTokenHttpError","kind":"json-schema","title":"InvalidTokenHttpError","data":{"type":"object","properties":{"message":{"type":"string","example":"Invalid token"},"error_code":{"type":"number","example":401}},"required":["message","error_code"]}},"components/schemas/ApiTokenExchangeRequestInput":{"id":"components/schemas/ApiTokenExchangeRequestInput","kind":"json-schema","title":"ApiTokenExchangeRequestInput","data":{"type":"object","properties":{"code":{"type":"string","description":"Authorization code returned in the redirect URI as a query parameter upon successful authentication","example":"GZxLFKTDCnlANVTxNvaWz7AIGPpXqZYSXdAwjiWRuOH"},"client_id":{"type":"string","description":"Client ID of the application requesting the token","example":"DgsdfhSDsdfhtSDFXCCXBVMKPws345yscv2345XCZV","maxLength":50},"client_secret":{"type":"string","description":"Client Secret of the application requesting the token","example":"FzxvdDMbvxnc45sdfb789XCVGEW6usazxcvbw3KPsb23","maxLength":50}},"required":["code","client_id","client_secret"]}},"components/schemas/ApiTokenExchangeResponse":{"id":"components/schemas/ApiTokenExchangeResponse","kind":"json-schema","title":"ApiTokenExchangeResponse","data":{"type":"object","properties":{"id_token":{"type":"string"},"access_token":{"type":"string"},"refresh_token":{"type":"string"},"is_user_created":{"type":"boolean","description":"Indicates if this is a new user or not"}},"required":["id_token","access_token","refresh_token","is_user_created"]}},"components/schemas/BadRequestHttpError":{"id":"components/schemas/BadRequestHttpError","kind":"json-schema","title":"BadRequestHttpError","data":{"type":"object","properties":{"message":{"example":"Bad request","type":"array","items":{"type":"string"}},"error_code":{"type":"number","example":400}},"required":["message","error_code"]}},"components/schemas/InvalidRedirectUriHttpError":{"id":"components/schemas/InvalidRedirectUriHttpError","kind":"json-schema","title":"InvalidRedirectUriHttpError","data":{"type":"object","properties":{"message":{"type":"string","example":"Invalid redirect_uri"},"error_code":{"type":"number","example":400}},"required":["message","error_code"]}},"schema_471":{"kind":"json-schema","data":{"maxLength":150,"type":"string"},"id":"schema_471"},"schema_472":{"kind":"json-schema","data":{"type":"string"},"id":"schema_472"},"schema_473":{"kind":"json-schema","data":{"default":true,"type":"boolean"},"id":"schema_473"},"schema_474":{"kind":"json-schema","data":{"default":false,"type":"boolean"},"id":"schema_474"}},"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/social-login.openapi.json?download"},{"url":"/_bundle/openapi/user/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 frontend integration for authentication, where the client obtains an authorization code that your app can exchange in the backend for user tokens."}},"baseSlug":"/openapi/user/social-login.openapi","routesMapping":{}}