{
  "opencollection": "1.0.0",
  "info": {
    "name": "Descope Apps Email API",
    "version": "0.0.1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Email",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Sign-Up",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/magiclink/signup/email",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-up new end user by sending a magic link via email\nInitiate a sign-up process by sending a magic link to a new end user. Descope will generate and deliver a clickable magic link to the email address specified. The clickable magic link is made up of two parts -  the URI you provide in the `URI` field and the magic link token generated by Descope. For example, if `URI=https://app.mycompany.com/magiclink/verify`, the clickable magic link will be `https://app.mycompany.com/magiclink/verify?t"
        },
        {
          "info": {
            "name": "Sign-In",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/magiclink/signin/email",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-in existing end user by sending a magic link via email\nInitiate a sign-in process by sending a magic link to an existing end user. Descope will generate and deliver a clickable magic link to the email address specified. The clickable magic link is made up of two parts - the URI you provide in the `URI` field and the magic link token generated by Descope. For example, if `URI=https://app.mycompany.com/magiclink/verify`, the clickable magic link will be `https://app.mycompany.com/magiclin"
        },
        {
          "info": {
            "name": "Sign-In with Auto Sign-up",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/magiclink/signup-in/email",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-in end user (with automatic sign-up) by sending a magic link via email\n\nInitiate a process that implements both sign-in and sign-up using a single endpoint. Descope will generate and deliver a clickable magic link to the email address specified. If the email address is already registered (the end user has already registered) the user will be signed in. If the email address is not registered (the end user is not yet registered) the user will be signed up.\n\nThe clickable magic link is mad"
        },
        {
          "info": {
            "name": "Update Email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/magiclink/update/email",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Update email of end user by sending magic link via email\nUpdate the email address of an existing end user by sending a magic link to the new email address. Descope will generate and deliver a clickable magic link to the new email address specified. After successfully verifying the magic link token the new email address will be used to deliver new magic links via email.\n\nThe clickable magic link is made up of two parts - the URI you provide in the `URI` field and the magic link token generate"
        },
        {
          "info": {
            "name": "Sign-Up",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/signup/email",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-up new end user by sending an OTP code via email\nInitiate a sign-up process by sending a One-Time Password (OTP) to a new end user. Descope will generate and deliver the OTP code to the email address specified. Sending multiple OTP codes (for example, when an end user tries to sign-up a second or third time) will invalidate any OTP code that has already been sent.\n\nThis endpoint will return an empty response object when it completes successfully. The endpoint will return a failure code "
        },
        {
          "info": {
            "name": "Sign-In",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/signin/email",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-in existing end user by sending an OTP code via email\nInitiate a sign-in process by sending a One-Time Password (OTP) to an existing end user. Descope will generate and deliver the OTP code to the email address specified. Sending multiple OTP codes (for example, when an end user tries to sign-in a second or third time) will invalidate any OTP code that has already been sent.\n\nThis endpoint will return an empty response object when it completes successfully. The endpoint will return a fa"
        },
        {
          "info": {
            "name": "Sign-In with Auto Sign-up",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/signup-in/email",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sign-in end user (with automatic sign-up) by sending an OTP code via email\nInitiate a process that implements both sign-in and sign-up using a single endpoint. Descope will generate and deliver the One-Time Password (OTP) to the end user via email. If the email address is already registered (the end user exists) the user will be signed in. If the email address is not registered (the end user is not yet registered) the user will be signed up. Sending multiple OTP codes (for example, when an e"
        },
        {
          "info": {
            "name": "Verify OTP Code",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/verify/email",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Verify the validity of an OTP code sent via email\n\nVerify that the OTP code entered by the end user matches the OTP code that was sent. The Verify OTP code endpoint completes the OTP via email flow for:\n- [Sign-Up](/api/otp/email/sign-up)\n- [Sign-In](/api/otp/email/sign-in)\n- [Sign-In with Auto Sign-up](/api/otp/email/sign-in-auto-sign-up)\n- [Update Email](/api/otp/email/update-email)\n\nThe response object includes the session JWT `sessionJwt` and refresh JWT `refreshJwt` when the endpoint co"
        },
        {
          "info": {
            "name": "Update Email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/otp/update/email",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Update Email Address of Existing User\nUpdate the email of an existing end user by sending an OTP code to the new email address. After successfully verifying the code the new email address will be used to deliver new OTP messages via email. The bearer token requires both the ProjectId and refresh JWT in the format `<Project ID>:<JWT>`, and can therefore only be run for end users who are currently signed-in.\n\nThis endpoint will return an empty response object when it completes successfully.\n\nD"
        },
        {
          "info": {
            "name": "Reset Password",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.descope.com/v1/auth/password/reset",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "### Sent a password reset email to an existing user utilizing the password API.\n\n### Next Steps\nYou will then need to verify the user after the password reset is sent via email, this would need to be done via [Verify Magic Link](/api/magic-link/verification/verify-token).\n\n### See Also\n- See [The User Object](/api/overview#the-user-object) for further details on how to identify users and their contact information such as email addresses and phone number.\n- You can also utilize [Update Password]("
        }
      ]
    }
  ],
  "bundled": true
}