Add users.EnrollAuthFactor() method

[jonatascastro12]

Description

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[ ] Yes

If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

[linear]

USRLD-1074 Add enrollAuthFactor method

curl https://api.workos.com/users/user_01H96FETWYSJMJEGF0Q3ZB272F/auth/factors \
  --header "Authorization: Bearer sk_test_a2V5XzAxSDBSRFRZQTZEWDFHWEdLOFRFVkRZM1EwLHdxa2lwaVY0UUtrWXdaYkNnRG84SVpoeDE" \
  -d type="totp"

Response

Status: 201 Created
Body: {
  "authentication_factor": {
    "object": "authentication_factor",
    "id": "auth_factor_01H96FETXENNY99ARX0GRC804C",
    "user_id": "user_01H96FETWYSJMJEGF0Q3ZB272F",
    "type": "totp",
    "totp": {
      "issuer": "Foo Corp",
      "qr_code": "data:image/png;base64,iVBOR...",
      "secret": "OFAFOQAPHR6XMQKAIYMWU72XIE3DGI3P",
      "uri": "otpauth://totp/Foo%20Corp:userfoo-corp.com?secret=OFAFOQAPHR6XMQKAIYMWU72XIE3DGI3P&issuer=Foo%20Corp&algorithm=SHA1&digits=6&period=30",
      "user": "userfoo-corp.com",
    },
    "created_at": "2023-08-31T18:59:57.962Z",
    "updated_at": "2023-08-31T18:59:57.962Z",
  },
  "authentication_challenge": {
    "object": "authentication_challenge",
    "id": "auth_challenge_01H96FETXGTW1QMBSBT2T36PW0",
    "authentication_factor_id": "auth_factor_01H96FETXENNY99ARX0GRC804C",
    "expires_at": "2023-08-31T19:09:57.999Z",
    "created_at": "2023-08-31T18:59:57.962Z",
    "updated_at": "2023-08-31T18:59:57.962Z",
  },
}

[jonatascastro12]

Current dependencies on/for this PR:

• main
  • PR Update Email Verification methods #251
    • PR Rename AuthenticateUserWith_ to AuthenticateWith_ #252
      • PR Adds missing tests for AuthenticateWithMagicAuth and SendMagicAuthCode #253
        • PR Add users.EnrollAuthFactor() method #254 👈
          • PR Add users.ListAuthFactor() method #255
            • PR Add users.AuthenticateWithTOTP() method #256
              • PR Rename password reset methods #257

This comment was auto-generated by Graphite.

[AshGodfrey]

In ruby I think this is called AuthenticationFactorAndChallenge (or was 6 days ago, we may want to discuss standardization on this)