Fetch Authenticators of User

🔐 Fetch Authenticators of User API

This API allows enterprise applications to fetch a list of authentication mechanisms (authenticators) associated with a specific REL-ID user. These include factors like the REL-ID Mobile App, TOTP, or other supported authentication methods.

🔗 Endpoint

GET https://REL-ID-SERVER-IP:9442/v1/users/{userId}/authenticators

🔐 Authorization

Authorization: Bearer <access_token>

📥 Path Parameter

Parameter	Location	Type	Required	Description
`userId`	Path	String	✅ Yes	REL-ID user ID whose authenticators are to be retrieved.

❌ Request Body

None (Leave body blank)

✅ Success Response

HTTP Code	Response Type	Description
`200 OK`	JSON Object	List of authenticators for the specified user.

🔄 Sample Success Response

{
  "authenticators": [
    {
      "authType": "relidmobileapp",
      "status": "ACTIVE",
      "authenticatorId": "2QIVSXR6D8M36AWM2I5MD8FELN9CM9W2WLJ4HB21ET4K6FOK7H",
      "authDescription": null,
      "failureCount": -1,
      "sucessfulCount": -1,
      "createdTs": 1704959869216
    }
  ]
}

📤 Response Field Descriptions

Field	Type	Description
`authType`	String	Type of authenticator (e.g., `relidmobileapp`, `totp`).
`status`	String	Status of the authenticator (e.g., `ACTIVE`).
`authenticatorId`	String	Unique identifier for the authenticator. Often device UUID.
`authDescription`	String	Optional description set for the authenticator.
`failureCount`	Integer	Number of failed authentication attempts. May return `-1` if unavailable.
`sucessfulCount`	Integer	Number of successful authentication attempts. May return `-1` if unavailable.
`createdTs`	Long (ms)	Timestamp of authenticator creation in epoch milliseconds.

❌ Error Responses (Collapsible)

🔍 404 - User Not Found or No Authenticators

{
  "timeStamp": "2023-05-30T12:33:32IST",
  "status": 404,
  "error": "user not found",
  "message": "User does not exists: abc",
  "path": "/v1/users/abc/authenticators"
}

💥 500 - Internal Server Error

{
  "timeStamp": "2023-05-30T12:33:32IST",
  "status": 500,
  "error": "Internal Server Error",
  "message": "Unexpected error occurred while processing request",
  "path": "/v1/users/abc/authenticators"
}

📝 Notes

Use this API to audit, analyze, or reset a user’s authenticators.
Results may include multiple authenticators per user depending on configuration.

Updated 3 months ago