How can we help you?

FeraAuth

Setup, administration, developer, and API documentation for FeraAuth.

FeraAuth

Apply a user to an application instance

Implements controller.apply in routes/api/v1/user/routes.js:10. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Authenticate for a local application redirect

Implements controller.local in routes/api/v1/auth/routes.js:69. This public identity boundary applies the documented field validation, safe credential responses, source-IP checks, rate limits, and delivery behavior without requiring an existing session.

Applies to all documented versions
FeraAuth

Authentication and credential security

Credentials and session security Interactive and service login requires a target instance , source IP whitelist acceptance, and instance scoped CAN.LOGIN . Interactive login verifies email/password with bcrypt. Service login…

Applies to all documented versions
FeraAuth

Authentication rate limiting

Authentication rate limiting All authentication entry points are protected in the service layer, so the /api/auth and /api/v1/auth aliases cannot bypass controls: Entry point Method checked Protection / , /local…

Applies to all documented versions
FeraAuth

Change a password with a reset token

Implements controller.change in routes/api/v1/auth/routes.js:102. This public identity boundary applies the documented field validation, safe credential responses, source-IP checks, rate limits, and delivery behavior without requiring an existing session.

Applies to all documented versions
FeraAuth

Check the current session permission

Implements controller.check in routes/api/v1/permission/routes.js:16. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Create an authenticated FeraAuth session

Implements controller.login in routes/api/v1/auth/routes.js:77. This public identity boundary applies the documented field validation, safe credential responses, source-IP checks, rate limits, and delivery behavior without requiring an existing session.

Applies to all documented versions
FeraAuth

Create or update an application instance

Implements controller.createOrUpdate in routes/api/v1/instance/routes.js:8. This public identity boundary applies the documented field validation, safe credential responses, source-IP checks, rate limits, and delivery behavior without requiring an existing session.

Applies to all documented versions
FeraAuth

Get a FeraAuth user by email address

Implements controller.get in routes/api/v1/user/routes.js:15. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Get a FeraAuth user by identifier

Implements controller.get in routes/api/v1/user/routes.js:16. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Get the current authenticated user

Implements controller.me in routes/api/v1/user/routes.js:17. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Grant an instance user’s owner permissions

Implements controller.makeOwner in routes/api/v1/user/routes.js:12. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Grant or revoke a named user permission

Implements controller.permit in routes/api/v1/user/routes.js:13. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Issue an email or SMS authentication challenge

Implements controller.sendChallenge in routes/api/v1/auth/routes.js:31. This public identity boundary applies the documented field validation, safe credential responses, source-IP checks, rate limits, and delivery behavior without requiring an existing session.

Applies to all documented versions
FeraAuth

List an instance user’s permissions

Implements controller.byUser in routes/api/v1/permission/routes.js:24. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

List permissions for the current principal

Implements controller.mine in routes/api/v1/permission/routes.js:22. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

List visible permission definitions

Implements controller.list in routes/api/v1/permission/routes.js:23. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Login, reset, and challenge flows

Login, reset, and challenge flows POST /api/v1/auth accepts either email/password or x api key , with the target instance header. The source IP, identity, whitelist, and CAN.LOGIN permission must all…

Applies to all documented versions
FeraAuth

Request a password-reset message

Implements controller.reset in routes/api/v1/auth/routes.js:92. This public identity boundary applies the documented field validation, safe credential responses, source-IP checks, rate limits, and delivery behavior without requiring an existing session.

Applies to all documented versions
FeraAuth

Resolve public application instance settings

Implements controller.get in routes/api/v1/instance/routes.js:9. This public identity boundary applies the documented field validation, safe credential responses, source-IP checks, rate limits, and delivery behavior without requiring an existing session.

Applies to all documented versions
FeraAuth

Revoke a user’s application instance access

Implements controller.revoke in routes/api/v1/user/routes.js:11. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Search users in the current application instance

Implements controller.search in routes/api/v1/user/routes.js:18. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

The ApiError object

Source-supported ApiError schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The AuthError object

Source-supported AuthError schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The AuthMutation object

Source-supported AuthMutation schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The AuthSuccess object

Source-supported AuthSuccess schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The AuthToken object

Source-supported AuthToken schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The ChallengeReceipt object

Source-supported ChallengeReceipt schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The ChallengeRequest object

Source-supported ChallengeRequest schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The ChallengeVerification object

Source-supported ChallengeVerification schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The LoginRequest object

Source-supported LoginRequest schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The Pagination object

Source-supported Pagination schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The ResourceId object

Source-supported ResourceId schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The Timestamp object

Source-supported Timestamp schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

The ValidationError object

Source-supported ValidationError schema for FeraAuth integrations.

Applies to all documented versions
FeraAuth

Verify a password-reset token

Implements controller.token in routes/api/v1/auth/routes.js:60. This public identity boundary applies the documented field validation, safe credential responses, source-IP checks, rate limits, and delivery behavior without requiring an existing session.

Applies to all documented versions
FeraAuth

Verify a user’s password for an administrator

Implements controller.verifyCredentials in routes/api/v1/user/routes.js:9. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions
FeraAuth

Verify an authentication challenge code

Implements controller.verifyChallenge in routes/api/v1/auth/routes.js:38. This public identity boundary applies the documented field validation, safe credential responses, source-IP checks, rate limits, and delivery behavior without requiring an existing session.

Applies to all documented versions
FeraAuth

Verify CalDAV credentials for an instance

Implements controller.verifyCaldav in routes/api/v1/auth/routes.js:48. This machine-to-machine identity boundary validates the documented service credential and instance-scoped permission before returning authorization facts.

Applies to all documented versions
FeraAuth

Verify the current authenticated session

Implements controller.verify in routes/api/v1/auth/routes.js:46. The x-auth-token middleware verifies the JWT and the service then enforces live-session, instance, and endpoint-specific permission requirements.

Applies to all documented versions