/
GOgovernment-digital-service
⌘K
DocsSign in
  • Docs
  • History
  • Schema
  • Generate
Invites9
Other1
Passwords3
Services14
Tasks1
Toolbox1
Users14
  • get/v1/api/usersGets users with the associated external ids
  • post/v1/api/usersCreate new user
  • post/v1/api/users/admin-emails-for-gateway-accountsGet admin user emails for given gateway account IDs
  • post/v1/api/users/authenticateAuthenticate a given email/password
  • post/v1/api/users/findFind user by email
  • get/v1/api/users/{userExternalId}Find user by user external ID
  • patch/v1/api/users/{userExternalId}Update user attributes
  • post/v1/api/users/{userExternalId}/reset-second-factorReset 2FA to SMS
  • post/v1/api/users/{userExternalId}/second-factorSend OTP via SMS for an existing user
  • post/v1/api/users/{userExternalId}/second-factor/activateActivate a new OTP key and method for a user
  • post/v1/api/users/{userExternalId}/second-factor/authenticateAuthenticate 2FA code
  • post/v1/api/users/{userExternalId}/second-factor/provisionCreate a new provisional OTP key for a user
  • post/v1/api/users/{userExternalId}/servicesAssign a new service along with role to a user
  • put/v1/api/users/{userExternalId}/services/{serviceExternalId}Update user's role for a service
    Users

    Send OTP via SMS for an existing user

    post/v1/api/users/{userExternalId}/second-factor

    Request

    • The document declares no server URL.
    • Auth
      none declared

    Path parameters

    userExternalIdstring required

    Request body

    string required

    Response

    OK

    Changes

    No recorded changes to this operation across all 53 revisions of this API.