Auth API
Methods exposed by an Own Auth instance.
Methods
| Area | Methods |
|---|---|
| Users | createUser signUpEmailPassword signInEmailPassword disableUser enableUser |
| Sessions | getCurrentSession requireCurrentSession signOut revokeSession revokeAllSessions listSessions |
| Magic Links | requestMagicLink verifyMagicLink |
| OAuth | createOAuthAuthorizationUrl completeOAuthSignIn linkOAuthProvider unlinkOAuthProvider prepareGoogleOneTap signInWithGoogleOneTap signInWithVerifiedExternalIdentity |
| SAML | auth.saml.createConnection auth.saml.getConnection auth.saml.listConnections auth.saml.updateConnection auth.saml.disableConnection auth.saml.enableConnection auth.saml.createSignInUrl auth.saml.createLinkUrl auth.saml.unlinkIdentity auth.saml.getMetadata |
| SCIM | auth.scim.createConnection auth.scim.getConnection auth.scim.listConnections auth.scim.updateConnection auth.scim.disableConnection auth.scim.enableConnection auth.scim.createToken auth.scim.listTokens auth.scim.revokeToken auth.scim.linkUser auth.scim.restoreUser |
| Provider Credentials | getExternalAccessToken revokeExternalProviderAccess |
| MFA | beginTotpEnrollment confirmTotpEnrollment completeMfaWithTotp completeMfaWithRecoveryCode regenerateRecoveryCodes disableTotp |
| Passkeys | beginPasskeyRegistration completePasskeyRegistration beginPasskeyAuthentication completePasskeyAuthentication listPasskeys renamePasskey revokePasskey |
| Email Verification | requestEmailVerification verifyEmail |
| Passwords | requestPasswordReset resetPassword changePassword |
| SMS OTP | requestSmsOtp verifySmsOtp |
| API Keys | createApiKey verifyApiKey revokeApiKey listApiKeys |
| Organisations | createOrganisation getOrganisation updateOrganisation deleteOrganisation listOrganisations |
| Members & Invites | getMember listMembers inviteMember acceptInvite revokeInvitation listInvitations changeMemberRole removeMember |
| Permissions | checkPermission requirePermission |
| Audit Logs | listAuditEvents cleanupAuditLogs |
| Administration | auth.admin.listUsers auth.admin.getUser auth.admin.listUserSessions auth.admin.listUserAuditEvents auth.admin.disableUser auth.admin.enableUser auth.admin.revokeUserSessions |
| Authorization Server | auth.authorizationServer.createClient auth.authorizationServer.listClients auth.authorizationServer.updateClient auth.authorizationServer.rotateClientSecret auth.authorizationServer.revokeClient auth.authorizationServer.createProtectedResource auth.authorizationServer.listProtectedResources auth.authorizationServer.updateProtectedResource auth.authorizationServer.rotateProtectedResourceSecret auth.authorizationServer.revokeProtectedResource auth.authorizationServer.getInteraction auth.authorizationServer.approveInteraction auth.authorizationServer.denyInteraction auth.authorizationServer.verifyAccessToken auth.authorizationServer.listUserGrants auth.authorizationServer.revokeUserGrant auth.authorizationServer.cleanupDpopProofs |
| Webhooks | processWebhookDeliveries listWebhookDeliveries retryWebhookDelivery cleanupWebhookDeliveries |
| Plugins | callPluginMethod plus methods and endpoints declared by configured plugins |
| Lifecycle | close |