Skip to content
Zautha

Overview

Zautha Backend API 1.0.0

Section titled “Zautha Backend API 1.0.0”

Manage an instance’s users, sessions and organizations from your server, with the instance’s secret key (sk_test_… or sk_live_…). Never send the secret key to a browser.

Information

  • OpenAPI version: 3.1.1

Operations

Section titled “Operations”
GET
/v1/backend/instance
GET
/v1/backend/jwks
GET
/v1/backend/users
POST
/v1/backend/users
GET
/v1/backend/users/{userId}
DELETE
/v1/backend/users/{userId}
PATCH
/v1/backend/users/{userId}
POST
/v1/backend/users/{userId}/ban
POST
/v1/backend/users/{userId}/unban
DELETE
/v1/backend/users/{userId}/mfa
GET
/v1/backend/users/{userId}/authorized_apps
POST
/v1/backend/users/{userId}/authorized_apps/{clientId}/revoke
GET
/v1/backend/users/{userId}/sessions
POST
/v1/backend/sessions/{sessionId}/revoke
POST
/v1/backend/sessions/revoke_all
POST
/v1/backend/actor_tokens
GET
/v1/backend/actor_tokens/{actorTokenId}
POST
/v1/backend/actor_tokens/{actorTokenId}/revoke
GET
/v1/backend/organizations
POST
/v1/backend/organizations
GET
/v1/backend/organizations/{organizationIdOrSlug}
DELETE
/v1/backend/organizations/{organizationIdOrSlug}
PATCH
/v1/backend/organizations/{organizationIdOrSlug}
PATCH
/v1/backend/organizations/{organizationId}/metadata
GET
/v1/backend/organizations/{organizationId}/memberships
POST
/v1/backend/organizations/{organizationId}/memberships
DELETE
/v1/backend/organizations/{organizationId}/memberships/{userId}
PATCH
/v1/backend/organizations/{organizationId}/memberships/{userId}
PATCH
/v1/backend/organizations/{organizationId}/memberships/{userId}/metadata
GET
/v1/backend/users/{userId}/organization_memberships
GET
/v1/backend/organizations/{organizationId}/invitations
POST
/v1/backend/organizations/{organizationId}/invitations
POST
/v1/backend/organizations/{organizationId}/invitations/bulk
GET
/v1/backend/organizations/{organizationId}/invitations/{invitationId}
POST
/v1/backend/organizations/{organizationId}/invitations/{invitationId}/revoke
GET
/v1/backend/organization_roles
POST
/v1/backend/organization_roles
GET
/v1/backend/organization_roles/{roleId}
DELETE
/v1/backend/organization_roles/{roleId}
PATCH
/v1/backend/organization_roles/{roleId}
GET
/v1/backend/organization_permissions
POST
/v1/backend/organization_permissions
GET
/v1/backend/organization_permissions/{permissionId}
DELETE
/v1/backend/organization_permissions/{permissionId}
PATCH
/v1/backend/organization_permissions/{permissionId}
POST
user.created WEBHOOK
POST
user.updated WEBHOOK
POST
user.deleted WEBHOOK
POST
session.created WEBHOOK
POST
session.ended WEBHOOK
POST
session.revoked WEBHOOK
POST
organization.created WEBHOOK
POST
organization.updated WEBHOOK
POST
organization.deleted WEBHOOK
POST
organizationMembership.created WEBHOOK
POST
organizationMembership.updated WEBHOOK
POST
organizationMembership.deleted WEBHOOK
POST
organizationInvitation.created WEBHOOK
POST
organizationInvitation.accepted WEBHOOK
POST
organizationInvitation.revoked WEBHOOK

Authentication

Section titled “Authentication”

secretKey

Section titled “secretKey”

The instance’s secret key, from the dashboard’s API keys page: Authorization: Bearer sk_test_… or sk_live_….

Security scheme type: http

Bearer format: sk_…