Users

Get a single user by authId

Required scope - read_user

get/api/v1/users/{authId}

Path parameters

authIdstring required

The authId of the user

Response

A single user object

Example response

{
  "user": {
    "attributes": {
      "attribute name 1": "value for attribute name 1",
      "attribute name 2": "value for attribute name 2"
    }
  }
}

Changes

Changed in 12 of the 50 revisions of this API.19629

    • added the optional property user/allOf[User]/invitationExpiresAt to the response with the 200 status

      response-optional-property-added

    • added the required property user/allOf[User]/isInviting to the response with the 200 status

      response-required-property-added

    • added the optional property user/allOf[subschema #2]/orgGroups to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property user/allOf[subschema #2]/attributes to the response with the 200 status

      response-optional-property-added

    • added the optional property user/allOf[subschema #2]/org to the response with the 200 status

      response-optional-property-added

    • added the optional property user/allOf[User]/linkedAuthId to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property user/allOf[User]/authId became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/createdAt became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/deletedAt became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/email became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/emailVerified became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/firstName became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/id became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/isActive became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/lastName became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/locale became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/otpVerified became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/smsPhoneNumberVerified became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/socialAccountId became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/socialAccountType became required for the status 200

      response-property-became-required

    • the response property user/allOf[User]/updatedAt became required for the status 200

      response-property-became-required

    • the response property user/allOf[subschema #2]/roles became required for the status 200

      response-property-became-required

    • added the required property user/allOf[User]/loginCount to the response with the 200 status

      response-required-property-added

    • added the required property user/allOf[User]/mfaTypes to the response with the 200 status

      response-required-property-added

    • added the optional property user/allOf[User]/smsPhoneNumberVerified to the response with the 200 status

      response-optional-property-added

  • 1f092af5030c12See the full diff
    • removed the optional property user/allOf[User]/googleId from the response with the 200 status

      response-optional-property-removed

    • added the optional property user/allOf[User]/socialAccountId to the response with the 200 status

      response-optional-property-added

    • added the optional property user/allOf[User]/socialAccountType to the response with the 200 status

      response-optional-property-added

    • added the optional property user/allOf[User]/googleId to the response with the 200 status

      response-optional-property-added