@greensecurity/javascript-sdk 0.45.0-beta.16 → 0.45.0-beta.18

package/dist/commonjs/models/components/loginrequirementsfromemail.js

@@ -44,9 +44,11 @@ const primitives_js_1 = require("../../lib/primitives.js");
 exports.LoginRequirementsFromEmail$outboundSchema = z.object({
     email: z.string(),
     returnUrl: z.string(),
+    ssoState: z.string().optional(),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {
         returnUrl: "return_url",
+        ssoState: "sso_state",
     });
 });
 function loginRequirementsFromEmailToJSON(loginRequirementsFromEmail) {

package/dist/commonjs/models/components/loginrequirementsfromemail.js.map

@@ -1 +1 @@
-{"version":3,"file":"loginrequirementsfromemail.js","sourceRoot":"","sources":["../../../../src/models/components/loginrequirementsfromemail.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCH,4EAMC;AA3CD,0CAA4B;AAC5B,2DAA0D;AAsB1D,gBAAgB;AACH,QAAA,yCAAyC,GAIlD,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,SAAS,EAAE,YAAY;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,0BAAsD;IAEtD,OAAO,IAAI,CAAC,SAAS,CACnB,iDAAyC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAC5E,CAAC;AACJ,CAAC"}
+{"version":3,"file":"loginrequirementsfromemail.js","sourceRoot":"","sources":["../../../../src/models/components/loginrequirementsfromemail.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2EH,4EAMC;AA/ED,0CAA4B;AAC5B,2DAA0D;AAwD1D,gBAAgB;AACH,QAAA,yCAAyC,GAIlD,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,SAAS,EAAE,YAAY;QACvB,QAAQ,EAAE,WAAW;KACtB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,0BAAsD;IAEtD,OAAO,IAAI,CAAC,SAAS,CACnB,iDAAyC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAC5E,CAAC;AACJ,CAAC"}

package/dist/commonjs/models/components/mfarequiredresponse.d.ts

@@ -26,6 +26,39 @@ export type MfaRequiredResponse = {
      */
     mobilePhone?: string | undefined;
     mfaMethod?: MfaMethod | undefined;
+    /**
+     * Opaque, signed state that Green Security issues when a third-party service
+     *
+     * @remarks
+     * provider starts a "Login with Green Security" SAML flow at
+     * `/saml/idp/sso`. The login screen receives it as the `sso_state` query
+     * string parameter and must pass it back, byte for byte, on every call to
+     * this endpoint for the remainder of the login journey — including the
+     * second call that carries an `mfa_code`.
+     *
+     * The blob is signed, not encrypted, and it expires five minutes after the
+     * service provider's request arrives. Do not parse it, shorten it, decode
+     * it, or re-encode it.
+     *
+     * **An invalid blob does not fail the login.** This is the opposite of what
+     * most integrators assume, so it is worth stating plainly: a forged, edited
+     * or expired `sso_state` is silently discarded, and the request then
+     * proceeds as an ordinary login. Valid credentials still authenticate and
+     * still return `200` — just with no `sso` object, leaving the user signed in
+     * to Green Security with no way back to the service provider that sent them.
+     * Never treat a `200` as proof that the SSO hand-off survived; check for
+     * `sso` explicitly.
+     *
+     * Every `202` response echoes the *verified* blob back in its own
+     * `sso_state` field. Always send back the value from the response you just
+     * received rather than the one you started with, so that a blob the server
+     * has already rejected is never resent, and so a client does not have to
+     * hold state of its own across the login journey.
+     *
+     * Omit this field entirely for an ordinary login that did not originate
+     * from a service provider.
+     */
+    ssoState?: string | undefined;
 };
 /** @internal */
 export declare const MfaMethod$inboundSchema: z.ZodType<MfaMethod, z.ZodTypeDef, unknown>;

package/dist/commonjs/models/components/mfarequiredresponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mfarequiredresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/mfarequiredresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,eAAO,MAAM,SAAS;;;CAGZ,CAAC;AACX,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,SAAS,CAAC,CAAC;AAEnD;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,UAAU,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAC6B,CAAC;AAEvC,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}
+{"version":3,"file":"mfarequiredresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/mfarequiredresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,eAAO,MAAM,SAAS;;;CAGZ,CAAC;AACX,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,SAAS,CAAC,CAAC;AAEnD;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,UAAU,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAC6B,CAAC;AAEvC,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}

package/dist/commonjs/models/components/mfarequiredresponse.js

@@ -56,10 +56,12 @@ exports.MfaRequiredResponse$inboundSchema = z.object({
     error: types.string(),
     mobile_phone: types.optional(types.string()),
     mfa_method: types.optional(exports.MfaMethod$inboundSchema),
+    sso_state: types.optional(types.string()),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {
         "mobile_phone": "mobilePhone",
         "mfa_method": "mfaMethod",
+        "sso_state": "ssoState",
     });
 });
 function mfaRequiredResponseFromJSON(jsonString) {

package/dist/commonjs/models/components/mfarequiredresponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"mfarequiredresponse.js","sourceRoot":"","sources":["../../../../src/models/components/mfarequiredresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+DH,kEAQC;AArED,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AACjD,gEAAkD;AAGlD,iEAAmD;AAGtC,QAAA,SAAS,GAAG;IACvB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACN,CAAC;AAwBX,gBAAgB;AACH,QAAA,uBAAuB,GAIhC,SAAS,CAAC,aAAa,CAAC,iBAAS,CAAC,CAAC;AAEvC,gBAAgB;AACH,QAAA,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;IACnC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;IACxB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;IACrB,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC5C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,+BAAuB,CAAC;CACpD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;QAC7B,YAAY,EAAE,WAAW;KAC1B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,2BAA2B,CACzC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"mfarequiredresponse.js","sourceRoot":"","sources":["../../../../src/models/components/mfarequiredresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkGH,kEAQC;AAxGD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AACjD,gEAAkD;AAGlD,iEAAmD;AAGtC,QAAA,SAAS,GAAG;IACvB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACN,CAAC;AAyDX,gBAAgB;AACH,QAAA,uBAAuB,GAIhC,SAAS,CAAC,aAAa,CAAC,iBAAS,CAAC,CAAC;AAEvC,gBAAgB;AACH,QAAA,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;IACnC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;IACxB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;IACrB,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC5C,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,+BAAuB,CAAC;IACnD,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;CAC1C,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;QAC7B,YAAY,EAAE,WAAW;QACzB,WAAW,EAAE,UAAU;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,2BAA2B,CACzC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC"}

package/dist/commonjs/models/components/passwordnotsetresponse.d.ts

@@ -12,9 +12,42 @@ export type PasswordNotSetResponse = {
      */
     error: string;
     /**
-     * URL to redirect the user to set their password (forgot password flow). Includes return_url query param when provided in the request.
+     * URL to redirect the user to set their password (forgot password flow). Carries the `return_url` and `sso_state` query params when those were provided on the request, because the browser follows this redirect and leaves the JSON body behind.
      */
     redirectUrl: string;
+    /**
+     * Opaque, signed state that Green Security issues when a third-party service
+     *
+     * @remarks
+     * provider starts a "Login with Green Security" SAML flow at
+     * `/saml/idp/sso`. The login screen receives it as the `sso_state` query
+     * string parameter and must pass it back, byte for byte, on every call to
+     * this endpoint for the remainder of the login journey — including the
+     * second call that carries an `mfa_code`.
+     *
+     * The blob is signed, not encrypted, and it expires five minutes after the
+     * service provider's request arrives. Do not parse it, shorten it, decode
+     * it, or re-encode it.
+     *
+     * **An invalid blob does not fail the login.** This is the opposite of what
+     * most integrators assume, so it is worth stating plainly: a forged, edited
+     * or expired `sso_state` is silently discarded, and the request then
+     * proceeds as an ordinary login. Valid credentials still authenticate and
+     * still return `200` — just with no `sso` object, leaving the user signed in
+     * to Green Security with no way back to the service provider that sent them.
+     * Never treat a `200` as proof that the SSO hand-off survived; check for
+     * `sso` explicitly.
+     *
+     * Every `202` response echoes the *verified* blob back in its own
+     * `sso_state` field. Always send back the value from the response you just
+     * received rather than the one you started with, so that a blob the server
+     * has already rejected is never resent, and so a client does not have to
+     * hold state of its own across the login journey.
+     *
+     * Omit this field entirely for an ordinary login that did not originate
+     * from a service provider.
+     */
+    ssoState?: string | undefined;
 };
 /** @internal */
 export declare const PasswordNotSetResponse$inboundSchema: z.ZodType<PasswordNotSetResponse, z.ZodTypeDef, unknown>;

package/dist/commonjs/models/components/passwordnotsetresponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"passwordnotsetresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/passwordnotsetresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,OAAO,CAUP,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAM7D"}
+{"version":3,"file":"passwordnotsetresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/passwordnotsetresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAM7D"}

package/dist/commonjs/models/components/passwordnotsetresponse.js

@@ -48,9 +48,11 @@ exports.PasswordNotSetResponse$inboundSchema = z.object({
     success: types.boolean(),
     error: types.string(),
     redirect_url: types.string(),
+    sso_state: types.optional(types.string()),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {
         "redirect_url": "redirectUrl",
+        "sso_state": "ssoState",
     });
 });
 function passwordNotSetResponseFromJSON(jsonString) {

package/dist/commonjs/models/components/passwordnotsetresponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"passwordnotsetresponse.js","sourceRoot":"","sources":["../../../../src/models/components/passwordnotsetresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCH,wEAQC;AA/CD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AAEjD,iEAAmD;AAmBnD,gBAAgB;AACH,QAAA,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC;IACzC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;IACxB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;IACrB,YAAY,EAAE,KAAK,CAAC,MAAM,EAAE;CAC7B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,8BAA8B,CAC5C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4CAAoC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChE,oDAAoD,CACrD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"passwordnotsetresponse.js","sourceRoot":"","sources":["../../../../src/models/components/passwordnotsetresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4EH,wEAQC;AAlFD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AAEjD,iEAAmD;AAoDnD,gBAAgB;AACH,QAAA,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC;IACzC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;IACxB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;IACrB,YAAY,EAAE,KAAK,CAAC,MAAM,EAAE;IAC5B,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;CAC1C,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;QAC7B,WAAW,EAAE,UAAU;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,8BAA8B,CAC5C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,4CAAoC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChE,oDAAoD,CACrD,CAAC;AACJ,CAAC"}

package/dist/commonjs/models/components/passwordrequiredresponse.d.ts

@@ -11,6 +11,39 @@ export type PasswordRequiredResponse = {
      * Error describing the exact condition of what further steps are needed to finish the login process.
      */
     error: string;
+    /**
+     * Opaque, signed state that Green Security issues when a third-party service
+     *
+     * @remarks
+     * provider starts a "Login with Green Security" SAML flow at
+     * `/saml/idp/sso`. The login screen receives it as the `sso_state` query
+     * string parameter and must pass it back, byte for byte, on every call to
+     * this endpoint for the remainder of the login journey — including the
+     * second call that carries an `mfa_code`.
+     *
+     * The blob is signed, not encrypted, and it expires five minutes after the
+     * service provider's request arrives. Do not parse it, shorten it, decode
+     * it, or re-encode it.
+     *
+     * **An invalid blob does not fail the login.** This is the opposite of what
+     * most integrators assume, so it is worth stating plainly: a forged, edited
+     * or expired `sso_state` is silently discarded, and the request then
+     * proceeds as an ordinary login. Valid credentials still authenticate and
+     * still return `200` — just with no `sso` object, leaving the user signed in
+     * to Green Security with no way back to the service provider that sent them.
+     * Never treat a `200` as proof that the SSO hand-off survived; check for
+     * `sso` explicitly.
+     *
+     * Every `202` response echoes the *verified* blob back in its own
+     * `sso_state` field. Always send back the value from the response you just
+     * received rather than the one you started with, so that a blob the server
+     * has already rejected is never resent, and so a client does not have to
+     * hold state of its own across the login journey.
+     *
+     * Omit this field entirely for an ordinary login that did not originate
+     * from a service provider.
+     */
+    ssoState?: string | undefined;
 };
 /** @internal */
 export declare const PasswordRequiredResponse$inboundSchema: z.ZodType<PasswordRequiredResponse, z.ZodTypeDef, unknown>;

package/dist/commonjs/models/components/passwordrequiredresponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"passwordrequiredresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/passwordrequiredresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,UAAU,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAKP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D"}
+{"version":3,"file":"passwordrequiredresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/passwordrequiredresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,QAAQ,EAAE,UAAU,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAUP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D"}

package/dist/commonjs/models/components/passwordrequiredresponse.js

@@ -39,6 +39,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PasswordRequiredResponse$inboundSchema = void 0;
 exports.passwordRequiredResponseFromJSON = passwordRequiredResponseFromJSON;
 const z = __importStar(require("zod/v3"));
+const primitives_js_1 = require("../../lib/primitives.js");
 const schemas_js_1 = require("../../lib/schemas.js");
 const types = __importStar(require("../../types/primitives.js"));
 /** @internal */
@@ -46,6 +47,11 @@ exports.PasswordRequiredResponse$inboundSchema = z.object({
     requires: types.literal("password"),
     success: types.boolean(),
     error: types.string(),
+    sso_state: types.optional(types.string()),
+}).transform((v) => {
+    return (0, primitives_js_1.remap)(v, {
+        "sso_state": "ssoState",
+    });
 });
 function passwordRequiredResponseFromJSON(jsonString) {
     return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.PasswordRequiredResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PasswordRequiredResponse' from JSON`);

package/dist/commonjs/models/components/passwordrequiredresponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"passwordrequiredresponse.js","sourceRoot":"","sources":["../../../../src/models/components/passwordrequiredresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,4EAQC;AArCD,0CAA4B;AAC5B,qDAAiD;AAEjD,iEAAmD;AAenD,gBAAgB;AACH,QAAA,sCAAsC,GAI/C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;IACnC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;IACxB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8CAAsC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClE,sDAAsD,CACvD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"passwordrequiredresponse.js","sourceRoot":"","sources":["../../../../src/models/components/passwordrequiredresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsEH,4EAQC;AA5ED,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AAEjD,iEAAmD;AAgDnD,gBAAgB;AACH,QAAA,sCAAsC,GAI/C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;IACnC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;IACxB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;IACrB,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;CAC1C,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,WAAW,EAAE,UAAU;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8CAAsC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClE,sDAAsD,CACvD,CAAC;AACJ,CAAC"}

package/dist/commonjs/models/components/samlloginrequiredresponse.d.ts

@@ -20,6 +20,39 @@ export type SamlLoginRequiredResponse = {
      * This is the URL that should be opened to initiate the SAML login flow
      */
     ssoUrl: string;
+    /**
+     * Opaque, signed state that Green Security issues when a third-party service
+     *
+     * @remarks
+     * provider starts a "Login with Green Security" SAML flow at
+     * `/saml/idp/sso`. The login screen receives it as the `sso_state` query
+     * string parameter and must pass it back, byte for byte, on every call to
+     * this endpoint for the remainder of the login journey — including the
+     * second call that carries an `mfa_code`.
+     *
+     * The blob is signed, not encrypted, and it expires five minutes after the
+     * service provider's request arrives. Do not parse it, shorten it, decode
+     * it, or re-encode it.
+     *
+     * **An invalid blob does not fail the login.** This is the opposite of what
+     * most integrators assume, so it is worth stating plainly: a forged, edited
+     * or expired `sso_state` is silently discarded, and the request then
+     * proceeds as an ordinary login. Valid credentials still authenticate and
+     * still return `200` — just with no `sso` object, leaving the user signed in
+     * to Green Security with no way back to the service provider that sent them.
+     * Never treat a `200` as proof that the SSO hand-off survived; check for
+     * `sso` explicitly.
+     *
+     * Every `202` response echoes the *verified* blob back in its own
+     * `sso_state` field. Always send back the value from the response you just
+     * received rather than the one you started with, so that a blob the server
+     * has already rejected is never resent, and so a client does not have to
+     * hold state of its own across the login journey.
+     *
+     * Omit this field entirely for an ordinary login that did not originate
+     * from a service provider.
+     */
+    ssoState?: string | undefined;
 };
 /** @internal */
 export declare const SamlLoginRequiredResponse$inboundSchema: z.ZodType<SamlLoginRequiredResponse, z.ZodTypeDef, unknown>;

package/dist/commonjs/models/components/samlloginrequiredresponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"samlloginrequiredresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/samlloginrequiredresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,OAAO,CAYP,CAAC;AAEH,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAMhE"}
+{"version":3,"file":"samlloginrequiredresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/samlloginrequiredresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAMhE"}

package/dist/commonjs/models/components/samlloginrequiredresponse.js

@@ -49,10 +49,12 @@ exports.SamlLoginRequiredResponse$inboundSchema = z.object({
     error: types.string(),
     sso_instructions: types.optional(types.string()),
     sso_url: types.string(),
+    sso_state: types.optional(types.string()),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {
         "sso_instructions": "ssoInstructions",
         "sso_url": "ssoUrl",
+        "sso_state": "ssoState",
     });
 });
 function samlLoginRequiredResponseFromJSON(jsonString) {

package/dist/commonjs/models/components/samlloginrequiredresponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"samlloginrequiredresponse.js","sourceRoot":"","sources":["../../../../src/models/components/samlloginrequiredresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDH,8EAQC;AAtDD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AAEjD,iEAAmD;AAwBnD,gBAAgB;AACH,QAAA,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;IACrC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;IACxB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;IACrB,gBAAgB,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAChD,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE;CACxB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,SAAS,EAAE,QAAQ;KACpB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,iCAAiC,CAC/C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,+CAAuC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnE,uDAAuD,CACxD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"samlloginrequiredresponse.js","sourceRoot":"","sources":["../../../../src/models/components/samlloginrequiredresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmFH,8EAQC;AAzFD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AAEjD,iEAAmD;AAyDnD,gBAAgB;AACH,QAAA,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;IACrC,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;IACxB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;IACrB,gBAAgB,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAChD,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE;IACvB,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;CAC1C,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,kBAAkB,EAAE,iBAAiB;QACrC,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,UAAU;KACxB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,iCAAiC,CAC/C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,+CAAuC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnE,uDAAuD,CACxD,CAAC;AACJ,CAAC"}

package/dist/commonjs/models/components/ssocontinuation.d.ts

@@ -0,0 +1,44 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * Where to send the browser to finish a "Login with Green Security" flow.
+ *
+ * @remarks
+ *
+ * Present on a `200` from `POST /users/authenticate` only when the request
+ * carried a valid, unexpired `sso_state`. Its absence means the login
+ * succeeded but the SAML flow did not resume — treat the login as an
+ * ordinary one rather than retrying.
+ *
+ * This object is additive. The login itself is unaffected by it: the
+ * caller's own permanent token is in `user_token` exactly as it would be on
+ * any other successful authentication, and it is not the token embedded in
+ * `continue_url`.
+ */
+export type SsoContinuation = {
+    /**
+     * An absolute, single-use URL on Green Security's domain. Navigate the
+     *
+     * @remarks
+     * browser to it (a full page navigation, not `fetch`); it answers with a
+     * self-submitting form that POSTs the signed `SAMLResponse` and the
+     * original `RelayState` to the service provider's assertion consumer
+     * service URL.
+     *
+     * The `token` in this URL is a separate **one-time** token that is
+     * consumed the first time the URL is followed, so the URL is good for
+     * exactly one navigation. It is not the caller's permanent token, which
+     * is returned unchanged in `user_token`. Treat the URL as a secret:
+     * whoever follows it first receives that user's assertion.
+     *
+     * Never fetch this URL from your own back end: the response is meant for
+     * the user's browser, and posting the assertion from anywhere else
+     * breaks the flow.
+     */
+    continueUrl: string;
+};
+/** @internal */
+export declare const SsoContinuation$inboundSchema: z.ZodType<SsoContinuation, z.ZodTypeDef, unknown>;
+export declare function ssoContinuationFromJSON(jsonString: string): SafeParseResult<SsoContinuation, SDKValidationError>;
+//# sourceMappingURL=ssocontinuation.d.ts.map

package/dist/commonjs/models/components/ssocontinuation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssocontinuation.d.ts","sourceRoot":"","sources":["../../../../src/models/components/ssocontinuation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAMtD"}

package/dist/commonjs/models/components/ssocontinuation.js

@@ -0,0 +1,56 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SsoContinuation$inboundSchema = void 0;
+exports.ssoContinuationFromJSON = ssoContinuationFromJSON;
+const z = __importStar(require("zod/v3"));
+const primitives_js_1 = require("../../lib/primitives.js");
+const schemas_js_1 = require("../../lib/schemas.js");
+const types = __importStar(require("../../types/primitives.js"));
+/** @internal */
+exports.SsoContinuation$inboundSchema = z.object({
+    continue_url: types.string(),
+}).transform((v) => {
+    return (0, primitives_js_1.remap)(v, {
+        "continue_url": "continueUrl",
+    });
+});
+function ssoContinuationFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.SsoContinuation$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'SsoContinuation' from JSON`);
+}
+//# sourceMappingURL=ssocontinuation.js.map

package/dist/commonjs/models/components/ssocontinuation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssocontinuation.js","sourceRoot":"","sources":["../../../../src/models/components/ssocontinuation.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DH,0DAQC;AAlED,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AAEjD,iEAAmD;AAyCnD,gBAAgB;AACH,QAAA,6BAA6B,GAItC,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,KAAK,CAAC,MAAM,EAAE;CAC7B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,uBAAuB,CACrC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qCAA6B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzD,6CAA6C,CAC9C,CAAC;AACJ,CAAC"}

package/dist/commonjs/models/operations/postauthenticate.d.ts

@@ -10,7 +10,7 @@ export type PostAuthenticateRequestBody = components.LoginEmailAndPassword | com
  * The request has been accepted for processing, but the processing has not been completed. The request might be processed later.
  */
 export type PostAuthenticateResponseBody = components.MfaRequiredResponse | components.SamlLoginRequiredResponse | components.PasswordRequiredResponse | components.PasswordNotSetResponse;
-export type PostAuthenticateResponse = components.User | components.MfaRequiredResponse | components.SamlLoginRequiredResponse | components.PasswordRequiredResponse | components.PasswordNotSetResponse;
+export type PostAuthenticateResponse = components.AuthenticateSuccessResponse | components.MfaRequiredResponse | components.SamlLoginRequiredResponse | components.PasswordRequiredResponse | components.PasswordNotSetResponse;
 /** @internal */
 export type PostAuthenticateRequestBody$Outbound = components.LoginEmailAndPassword$Outbound | components.LoginRequirementsFromEmail$Outbound;
 /** @internal */

package/dist/commonjs/models/operations/postauthenticate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postauthenticate.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/postauthenticate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,UAAU,CAAC,qBAAqB,GAChC,UAAU,CAAC,0BAA0B,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,UAAU,CAAC,mBAAmB,GAC9B,UAAU,CAAC,yBAAyB,GACpC,UAAU,CAAC,wBAAwB,GACnC,UAAU,CAAC,sBAAsB,CAAC;AAEtC,MAAM,MAAM,wBAAwB,GAChC,UAAU,CAAC,IAAI,GACf,UAAU,CAAC,mBAAmB,GAC9B,UAAU,CAAC,yBAAyB,GACpC,UAAU,CAAC,wBAAwB,GACnC,UAAU,CAAC,sBAAsB,CAAC;AAEtC,gBAAgB;AAChB,MAAM,MAAM,oCAAoC,GAC5C,UAAU,CAAC,8BAA8B,GACzC,UAAU,CAAC,mCAAmC,CAAC;AAEnD,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,oCAAoC,EACpC,CAAC,CAAC,UAAU,EACZ,2BAA2B,CAI3B,CAAC;AAEH,wBAAgB,iCAAiC,CAC/C,2BAA2B,EAAE,2BAA2B,GACvD,MAAM,CAMR;AAED,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,oCAAoC,CAClD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,4BAA4B,EAAE,kBAAkB,CAAC,CAMnE;AAED,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D"}
+{"version":3,"file":"postauthenticate.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/postauthenticate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,UAAU,CAAC,qBAAqB,GAChC,UAAU,CAAC,0BAA0B,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,UAAU,CAAC,mBAAmB,GAC9B,UAAU,CAAC,yBAAyB,GACpC,UAAU,CAAC,wBAAwB,GACnC,UAAU,CAAC,sBAAsB,CAAC;AAEtC,MAAM,MAAM,wBAAwB,GAChC,UAAU,CAAC,2BAA2B,GACtC,UAAU,CAAC,mBAAmB,GAC9B,UAAU,CAAC,yBAAyB,GACpC,UAAU,CAAC,wBAAwB,GACnC,UAAU,CAAC,sBAAsB,CAAC;AAEtC,gBAAgB;AAChB,MAAM,MAAM,oCAAoC,GAC5C,UAAU,CAAC,8BAA8B,GACzC,UAAU,CAAC,mCAAmC,CAAC;AAEnD,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,oCAAoC,EACpC,CAAC,CAAC,UAAU,EACZ,2BAA2B,CAI3B,CAAC;AAEH,wBAAgB,iCAAiC,CAC/C,2BAA2B,EAAE,2BAA2B,GACvD,MAAM,CAMR;AAED,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,oCAAoC,CAClD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,4BAA4B,EAAE,kBAAkB,CAAC,CAMnE;AAED,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D"}

package/dist/commonjs/models/operations/postauthenticate.js

@@ -64,7 +64,7 @@ function postAuthenticateResponseBodyFromJSON(jsonString) {
 }
 /** @internal */
 exports.PostAuthenticateResponse$inboundSchema = (0, smartUnion_js_1.smartUnion)([
-    components.User$inboundSchema,
+    components.AuthenticateSuccessResponse$inboundSchema,
     z.union([
         components.MfaRequiredResponse$inboundSchema,
         components.SamlLoginRequiredResponse$inboundSchema,

package/dist/commonjs/models/operations/postauthenticate.js.map

@@ -1 +1 @@
-{"version":3,"file":"postauthenticate.js","sourceRoot":"","sources":["../../../../src/models/operations/postauthenticate.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CH,8EAQC;AAcD,oFAQC;AAiBD,4EAQC;AApGD,0CAA4B;AAC5B,qDAAiD;AAEjD,6DAAuD;AACvD,mEAAqD;AA+BrD,gBAAgB;AACH,QAAA,0CAA0C,GAInD,IAAA,0BAAU,EAAC;IACb,UAAU,CAAC,oCAAoC;IAC/C,UAAU,CAAC,yCAAyC;CACrD,CAAC,CAAC;AAEH,SAAgB,iCAAiC,CAC/C,2BAAwD;IAExD,OAAO,IAAI,CAAC,SAAS,CACnB,kDAA0C,CAAC,KAAK,CAC9C,2BAA2B,CAC5B,CACF,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,0CAA0C,GAInD,CAAC,CAAC,KAAK,CAAC;IACV,UAAU,CAAC,iCAAiC;IAC5C,UAAU,CAAC,uCAAuC;IAClD,UAAU,CAAC,sCAAsC;IACjD,UAAU,CAAC,oCAAoC;CAChD,CAAC,CAAC;AAEH,SAAgB,oCAAoC,CAClD,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kDAA0C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtE,0DAA0D,CAC3D,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,sCAAsC,GAI/C,IAAA,0BAAU,EAAC;IACb,UAAU,CAAC,kBAAkB;IAC7B,CAAC,CAAC,KAAK,CAAC;QACN,UAAU,CAAC,iCAAiC;QAC5C,UAAU,CAAC,uCAAuC;QAClD,UAAU,CAAC,sCAAsC;QACjD,UAAU,CAAC,oCAAoC;KAChD,CAAC;CACH,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8CAAsC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClE,sDAAsD,CACvD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"postauthenticate.js","sourceRoot":"","sources":["../../../../src/models/operations/postauthenticate.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CH,8EAQC;AAcD,oFAQC;AAiBD,4EAQC;AApGD,0CAA4B;AAC5B,qDAAiD;AAEjD,6DAAuD;AACvD,mEAAqD;AA+BrD,gBAAgB;AACH,QAAA,0CAA0C,GAInD,IAAA,0BAAU,EAAC;IACb,UAAU,CAAC,oCAAoC;IAC/C,UAAU,CAAC,yCAAyC;CACrD,CAAC,CAAC;AAEH,SAAgB,iCAAiC,CAC/C,2BAAwD;IAExD,OAAO,IAAI,CAAC,SAAS,CACnB,kDAA0C,CAAC,KAAK,CAC9C,2BAA2B,CAC5B,CACF,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,0CAA0C,GAInD,CAAC,CAAC,KAAK,CAAC;IACV,UAAU,CAAC,iCAAiC;IAC5C,UAAU,CAAC,uCAAuC;IAClD,UAAU,CAAC,sCAAsC;IACjD,UAAU,CAAC,oCAAoC;CAChD,CAAC,CAAC;AAEH,SAAgB,oCAAoC,CAClD,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,kDAA0C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtE,0DAA0D,CAC3D,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,sCAAsC,GAI/C,IAAA,0BAAU,EAAC;IACb,UAAU,CAAC,yCAAyC;IACpD,CAAC,CAAC,KAAK,CAAC;QACN,UAAU,CAAC,iCAAiC;QAC5C,UAAU,CAAC,uCAAuC;QAClD,UAAU,CAAC,sCAAsC;QACjD,UAAU,CAAC,oCAAoC;KAChD,CAAC;CACH,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8CAAsC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClE,sDAAsD,CACvD,CAAC;AACJ,CAAC"}

package/dist/commonjs/react-query/usersPostAuthenticate.d.ts

@@ -49,6 +49,43 @@ export type UsersPostAuthenticateMutationError = errors.ApiErrorResponse | Green
  * 3. Site redirects to your selected `return_url`
  * 4. The `user_token` will be appended as a query string parameter to your `return_url` - you must parse this token and store it
  * 5. Fetch the user object from `/users/me` using the token
+ *
+ * ## Finishing a "Login with Green Security" flow
+ *
+ * Green Security is also a SAML2 **identity provider**. When a third-party service provider sends a user to
+ * `/saml/idp/sso` to sign in with their Green Security account, the user lands on a Green Security login screen
+ * carrying an `sso_state` query string parameter. That parameter is a signed, five-minute record of which service
+ * provider is waiting, where its assertion consumer service lives, and what `RelayState` it sent.
+ *
+ * Authentication itself is unchanged - the user may still need a password, an MFA code, a magic link or a round trip
+ * to their own SAML IdP, and every `requires` value above applies as normal. The only difference is that you must
+ * echo `sso_state` back on **every** call in the sequence, unchanged, including the follow-up that carries the
+ * `mfa_code`.
+ *
+ * Each `202` response carries the verified blob back to you in its own top-level `sso_state` field. Send back the
+ * value from the response you just received rather than the one you started with. The two are normally the same
+ * string, but re-sending your original copy is how a blob the server has already rejected gets resent, and it forces
+ * you to hold login state you would otherwise not need.
+ *
+ * 1. Read `sso_state` from the query string of the login screen you were sent to
+ * 2. Run the login exactly as you would otherwise, adding `sso_state` to each request body and taking the value for
+ *    the next request from the previous `202` response
+ * 3. On the `200` response, read `sso.continue_url`
+ * 4. Navigate the browser to `sso.continue_url` - a full page navigation, not a background fetch. It answers with a
+ *    self-submitting form that delivers the signed `SAMLResponse` and the original `RelayState` to the service
+ *    provider
+ * 5. The service provider validates the assertion and the user is signed in on their side
+ *
+ * On the `password_reset` leg the blob is **also** appended to `redirect_url` as a query parameter, alongside
+ * `return_url`. The browser follows that redirect and leaves the JSON body behind, so anything the remaining legs of
+ * the login still need has to ride the URL. Preserve the query string exactly as given.
+ *
+ * An invalid `sso_state` never fails a login. A forged, edited or expired blob is silently dropped and the request is
+ * then treated as an ordinary login, so valid credentials still return `200` - just with no `sso` object. Check for
+ * `sso` explicitly rather than reading `200` as proof the hand-off survived. When it is absent, do not retry with the
+ * same blob; the user has to start again from the service provider. See the
+ * [Login with Green Security](https://greensecurity.apidocumentation.com/guides/sso-login-with-green-security)
+ * guide for the service provider half of this flow.
  */
 export declare function useUsersPostAuthenticateMutation(options?: MutationHookOptions<UsersPostAuthenticateMutationData, UsersPostAuthenticateMutationError, UsersPostAuthenticateMutationVariables>): UseMutationResult<UsersPostAuthenticateMutationData, UsersPostAuthenticateMutationError, UsersPostAuthenticateMutationVariables>;
 export declare function mutationKeyUsersPostAuthenticate(): MutationKey;

package/dist/commonjs/react-query/usersPostAuthenticate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"usersPostAuthenticate.d.ts","sourceRoot":"","sources":["../../../src/react-query/usersPostAuthenticate.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,WAAW,EAEX,iBAAiB,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAG/C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,MAAM,MAAM,sCAAsC,GAAG;IACnD,OAAO,EAAE,UAAU,CAAC,2BAA2B,CAAC;IAChD,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAC3C,UAAU,CAAC,wBAAwB,CAAC;AAEtC,MAAM,MAAM,kCAAkC,GAC1C,MAAM,CAAC,gBAAgB,GACvB,kBAAkB,GAClB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,CAAC,EAAE,mBAAmB,CAC3B,iCAAiC,EACjC,kCAAkC,EAClC,sCAAsC,CACvC,GACA,iBAAiB,CAClB,iCAAiC,EACjC,kCAAkC,EAClC,sCAAsC,CACvC,CAMA;AAED,wBAAgB,gCAAgC,IAAI,WAAW,CAE9D;AAED,wBAAgB,kCAAkC,CAChD,OAAO,EAAE,iBAAiB,EAC1B,WAAW,CAAC,EAAE,cAAc,GAC3B;IACD,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,CACV,SAAS,EAAE,sCAAsC,KAC9C,OAAO,CAAC,iCAAiC,CAAC,CAAC;CACjD,CA0BA"}
+{"version":3,"file":"usersPostAuthenticate.d.ts","sourceRoot":"","sources":["../../../src/react-query/usersPostAuthenticate.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,WAAW,EAEX,iBAAiB,EAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAG/C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,MAAM,MAAM,sCAAsC,GAAG;IACnD,OAAO,EAAE,UAAU,CAAC,2BAA2B,CAAC;IAChD,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAC3C,UAAU,CAAC,wBAAwB,CAAC;AAEtC,MAAM,MAAM,kCAAkC,GAC1C,MAAM,CAAC,gBAAgB,GACvB,kBAAkB,GAClB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,wBAAgB,gCAAgC,CAC9C,OAAO,CAAC,EAAE,mBAAmB,CAC3B,iCAAiC,EACjC,kCAAkC,EAClC,sCAAsC,CACvC,GACA,iBAAiB,CAClB,iCAAiC,EACjC,kCAAkC,EAClC,sCAAsC,CACvC,CAMA;AAED,wBAAgB,gCAAgC,IAAI,WAAW,CAE9D;AAED,wBAAgB,kCAAkC,CAChD,OAAO,EAAE,iBAAiB,EAC1B,WAAW,CAAC,EAAE,cAAc,GAC3B;IACD,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,CACV,SAAS,EAAE,sCAAsC,KAC9C,OAAO,CAAC,iCAAiC,CAAC,CAAC;CACjD,CA0BA"}

package/dist/commonjs/react-query/usersPostAuthenticate.js

@@ -46,6 +46,43 @@ const _context_js_1 = require("./_context.js");
  * 3. Site redirects to your selected `return_url`
  * 4. The `user_token` will be appended as a query string parameter to your `return_url` - you must parse this token and store it
  * 5. Fetch the user object from `/users/me` using the token
+ *
+ * ## Finishing a "Login with Green Security" flow
+ *
+ * Green Security is also a SAML2 **identity provider**. When a third-party service provider sends a user to
+ * `/saml/idp/sso` to sign in with their Green Security account, the user lands on a Green Security login screen
+ * carrying an `sso_state` query string parameter. That parameter is a signed, five-minute record of which service
+ * provider is waiting, where its assertion consumer service lives, and what `RelayState` it sent.
+ *
+ * Authentication itself is unchanged - the user may still need a password, an MFA code, a magic link or a round trip
+ * to their own SAML IdP, and every `requires` value above applies as normal. The only difference is that you must
+ * echo `sso_state` back on **every** call in the sequence, unchanged, including the follow-up that carries the
+ * `mfa_code`.
+ *
+ * Each `202` response carries the verified blob back to you in its own top-level `sso_state` field. Send back the
+ * value from the response you just received rather than the one you started with. The two are normally the same
+ * string, but re-sending your original copy is how a blob the server has already rejected gets resent, and it forces
+ * you to hold login state you would otherwise not need.
+ *
+ * 1. Read `sso_state` from the query string of the login screen you were sent to
+ * 2. Run the login exactly as you would otherwise, adding `sso_state` to each request body and taking the value for
+ *    the next request from the previous `202` response
+ * 3. On the `200` response, read `sso.continue_url`
+ * 4. Navigate the browser to `sso.continue_url` - a full page navigation, not a background fetch. It answers with a
+ *    self-submitting form that delivers the signed `SAMLResponse` and the original `RelayState` to the service
+ *    provider
+ * 5. The service provider validates the assertion and the user is signed in on their side
+ *
+ * On the `password_reset` leg the blob is **also** appended to `redirect_url` as a query parameter, alongside
+ * `return_url`. The browser follows that redirect and leaves the JSON body behind, so anything the remaining legs of
+ * the login still need has to ride the URL. Preserve the query string exactly as given.
+ *
+ * An invalid `sso_state` never fails a login. A forged, edited or expired blob is silently dropped and the request is
+ * then treated as an ordinary login, so valid credentials still return `200` - just with no `sso` object. Check for
+ * `sso` explicitly rather than reading `200` as proof the hand-off survived. When it is absent, do not retry with the
+ * same blob; the user has to start again from the service provider. See the
+ * [Login with Green Security](https://greensecurity.apidocumentation.com/guides/sso-login-with-green-security)
+ * guide for the service provider half of this flow.
  */
 function useUsersPostAuthenticateMutation(options) {
     const client = (0, _context_js_1.useGreenSecurityContext)();

package/dist/commonjs/react-query/usersPostAuthenticate.js.map

@@ -1 +1 @@
-{"version":3,"file":"usersPostAuthenticate.js","sourceRoot":"","sources":["../../../src/react-query/usersPostAuthenticate.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAkFH,4EAgBC;AAED,4EAEC;AAED,gFAkCC;AAxID,uDAI+B;AAE/B,gFAA0E;AAC1E,wDAAsD;AActD,0CAA6C;AAC7C,+CAAwD;AAsBxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,gCAAgC,CAC9C,OAIC;IAMD,MAAM,MAAM,GAAG,IAAA,qCAAuB,GAAE,CAAC;IACzC,OAAO,IAAA,yBAAW,EAAC;QACjB,GAAG,kCAAkC,CAAC,MAAM,EAAE,OAAO,CAAC;QACtD,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,gCAAgC;IAC9C,OAAO,CAAC,+BAA+B,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;AACxE,CAAC;AAED,SAAgB,kCAAkC,CAChD,OAA0B,EAC1B,WAA4B;IAO5B,OAAO;QACL,WAAW,EAAE,gCAAgC,EAAE;QAC/C,UAAU,EAAE,SAAS,+BAA+B,CAAC,EACnD,OAAO,EACP,OAAO,GACR;YACC,MAAM,aAAa,GAAG;gBACpB,GAAG,WAAW;gBACd,GAAG,OAAO;gBACV,YAAY,EAAE;oBACZ,GAAG,WAAW,EAAE,YAAY;oBAC5B,GAAG,OAAO,EAAE,YAAY;oBACxB,MAAM,EAAE,IAAA,8BAAc,EACpB,WAAW,EAAE,YAAY,EAAE,MAAM,EACjC,OAAO,EAAE,YAAY,EAAE,MAAM,CAC9B;iBACF;aACF,CAAC;YACF,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,OAAO,EACP,OAAO,EACP,aAAa,CACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"usersPostAuthenticate.js","sourceRoot":"","sources":["../../../src/react-query/usersPostAuthenticate.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAuHH,4EAgBC;AAED,4EAEC;AAED,gFAkCC;AA7KD,uDAI+B;AAE/B,gFAA0E;AAC1E,wDAAsD;AActD,0CAA6C;AAC7C,+CAAwD;AAsBxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,SAAgB,gCAAgC,CAC9C,OAIC;IAMD,MAAM,MAAM,GAAG,IAAA,qCAAuB,GAAE,CAAC;IACzC,OAAO,IAAA,yBAAW,EAAC;QACjB,GAAG,kCAAkC,CAAC,MAAM,EAAE,OAAO,CAAC;QACtD,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,gCAAgC;IAC9C,OAAO,CAAC,+BAA+B,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;AACxE,CAAC;AAED,SAAgB,kCAAkC,CAChD,OAA0B,EAC1B,WAA4B;IAO5B,OAAO;QACL,WAAW,EAAE,gCAAgC,EAAE;QAC/C,UAAU,EAAE,SAAS,+BAA+B,CAAC,EACnD,OAAO,EACP,OAAO,GACR;YACC,MAAM,aAAa,GAAG;gBACpB,GAAG,WAAW;gBACd,GAAG,OAAO;gBACV,YAAY,EAAE;oBACZ,GAAG,WAAW,EAAE,YAAY;oBAC5B,GAAG,OAAO,EAAE,YAAY;oBACxB,MAAM,EAAE,IAAA,8BAAc,EACpB,WAAW,EAAE,YAAY,EAAE,MAAM,EACjC,OAAO,EAAE,YAAY,EAAE,MAAM,CAC9B;iBACF;aACF,CAAC;YACF,OAAO,IAAA,mBAAW,EAAC,IAAA,gDAAqB,EACtC,OAAO,EACP,OAAO,EACP,aAAa,CACd,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/users.d.ts

@@ -100,6 +100,43 @@ export declare class Users extends ClientSDK {
      * 3. Site redirects to your selected `return_url`
      * 4. The `user_token` will be appended as a query string parameter to your `return_url` - you must parse this token and store it
      * 5. Fetch the user object from `/users/me` using the token
+     *
+     * ## Finishing a "Login with Green Security" flow
+     *
+     * Green Security is also a SAML2 **identity provider**. When a third-party service provider sends a user to
+     * `/saml/idp/sso` to sign in with their Green Security account, the user lands on a Green Security login screen
+     * carrying an `sso_state` query string parameter. That parameter is a signed, five-minute record of which service
+     * provider is waiting, where its assertion consumer service lives, and what `RelayState` it sent.
+     *
+     * Authentication itself is unchanged - the user may still need a password, an MFA code, a magic link or a round trip
+     * to their own SAML IdP, and every `requires` value above applies as normal. The only difference is that you must
+     * echo `sso_state` back on **every** call in the sequence, unchanged, including the follow-up that carries the
+     * `mfa_code`.
+     *
+     * Each `202` response carries the verified blob back to you in its own top-level `sso_state` field. Send back the
+     * value from the response you just received rather than the one you started with. The two are normally the same
+     * string, but re-sending your original copy is how a blob the server has already rejected gets resent, and it forces
+     * you to hold login state you would otherwise not need.
+     *
+     * 1. Read `sso_state` from the query string of the login screen you were sent to
+     * 2. Run the login exactly as you would otherwise, adding `sso_state` to each request body and taking the value for
+     *    the next request from the previous `202` response
+     * 3. On the `200` response, read `sso.continue_url`
+     * 4. Navigate the browser to `sso.continue_url` - a full page navigation, not a background fetch. It answers with a
+     *    self-submitting form that delivers the signed `SAMLResponse` and the original `RelayState` to the service
+     *    provider
+     * 5. The service provider validates the assertion and the user is signed in on their side
+     *
+     * On the `password_reset` leg the blob is **also** appended to `redirect_url` as a query parameter, alongside
+     * `return_url`. The browser follows that redirect and leaves the JSON body behind, so anything the remaining legs of
+     * the login still need has to ride the URL. Preserve the query string exactly as given.
+     *
+     * An invalid `sso_state` never fails a login. A forged, edited or expired blob is silently dropped and the request is
+     * then treated as an ordinary login, so valid credentials still return `200` - just with no `sso` object. Check for
+     * `sso` explicitly rather than reading `200` as proof the hand-off survived. When it is absent, do not retry with the
+     * same blob; the user has to start again from the service provider. See the
+     * [Login with Green Security](https://greensecurity.apidocumentation.com/guides/sso-login-with-green-security)
+     * guide for the service provider half of this flow.
      */
     postAuthenticate(request: operations.PostAuthenticateRequestBody, options?: RequestOptions): Promise<operations.PostAuthenticateResponse>;
     /**