Function getUserAuthMethods

GET /users/{userId}/authentication-methods – Retrieves all authentication methods for a user.

---

📥 Request

Headers:

• Authorization: Bearer <access_token> (required)
• Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

• None

Path Parameters:

• userId: The user ID of which user to retrieve authentication methods for (required)

Query Parameters:

• provider: The authentication provider (optional). Defaults to auth0-user.
• userPoolId: The Cognito user pool ID (required for Cognito)

---

📤 Response

• 200 OK – Returns the user's authentication methods (see examples for provider-specific responses).

---

❗ Errors

Status Code	Meaning	When it Happens
400	Bad Request	Missing or invalid fields in request body
401	Unauthorized	Missing or invalid authentication token
404	Not Found	Specified user does not exist
500	Internal Server Error	Unexpected error during user auth methods retrieval

Error Response Format

{
  "error": "Detailed error message here"
}
Copy

---

📦 Examples

📥 Auth0 Request

GET /users/exampleUserId/authentication-methods
Copy

📤 Auth0 Response Example

{
   	authenticators: {
		"id": "authenticator_id",
		"type": "authenticator_type",
		"confirmed": boolean,
		"name": "authenticator_name",
		"authenticationMethods": {
			"id": "method_id",
			"type": "method_type",
		}[],
  			"preferredAuthenticationMethod": string,
		"linkId": string,
		"phoneNumber": string,
		"email": string,
		"keyId": string,
		"publicKey": string,
		"createdAt": string,
		"enrolledAt": string,
		"lastAuthAt": string,
		"credentialDeviceType": string,
		"credentialBackedUp": boolean,
		"identityUserId": string,
		"userAgent": string,
	}[],
   }
Copy

📥 Cognito Request

GET /users/exampleUserId/authentication-methods?userPoolId=us-east-1_1234test&provider=cognito-user
Copy

📤 Cognito Response Example

{
	"authenticators": {
		"preferredAuthenticationMethod": string | null,
		"authenticationMethods": {@link AuthMethod[]},
		"availableMethods": {
			"softwareToken": boolean,
			"SMS": boolean,
		},
   }
Copy

---