Auth Consumer API.
Sign in your end-users, verify their tokens, and check permissions. Every endpoint is generated from the live OpenAPI spec.
Replace {app_slug} in every URL with the slug of your Auth app. Open the app in the console — the slug is shown on its Settings tab, next to the app id.
Base URL
https://api.auth.productcraft.coAuth
Authorization: Bearer …Spec version
OpenAPI spec
https://api.auth.productcraft.co/docs-jsonConsumer-Admin
Manage the app's users from your backend with an app-scoped token or API key: create, list, update and delete them.
- get
/{app_slug}/v1/admin/usersList end-users in this app - post
/{app_slug}/v1/admin/usersProvision a new end-user - get
/{app_slug}/v1/admin/users/{user_id}Read one end-user - patch
/{app_slug}/v1/admin/users/{user_id}Update an end-user's display name or primary email - delete
/{app_slug}/v1/admin/users/{user_id}Permanently delete an end-user - patch
/{app_slug}/v1/admin/users/{user_id}/statusChange an end-user status (active / suspended / deactivated) - patch
/{app_slug}/v1/admin/users/{user_id}/roleAssign an end-user a role
Consumer-Admin-Mfa
Provision and remove a user's MFA factors from your backend with a workspace API key (synthetic and agent accounts).
Consumer-Admin-Permissions
Manage the app's permission catalogue from your backend.
Consumer-Admin-Roles
Manage the app's roles and their permissions from your backend.
- get
/{app_slug}/v1/admin/rolesList roles in this app - post
/{app_slug}/v1/admin/rolesCreate a role - get
/{app_slug}/v1/admin/roles/{role_name}Read one role with its permission set - patch
/{app_slug}/v1/admin/roles/{role_name}Update a role's description - delete
/{app_slug}/v1/admin/roles/{role_name}Delete a custom role - put
/{app_slug}/v1/admin/roles/{role_name}/permissionsReplace a role's permission set
Consumer-Agent-Access
Agent access (OAuth for MCP): let an AI agent act for one of your users after their browser consent. The consent API your consent page calls, the user's connected agents, and the PAK lane your backend uses to push settings and verify agent tokens. The OAuth endpoints themselves (discovery, register, authorize, token, revoke) follow RFC 8414 / 7591 / 6749 / 7009 and are documented on productcraft.co/docs/auth/agent-access.
- get
/{app_slug}/v1/agent-access/configRead this app's agent access settings - put
/{app_slug}/v1/agent-access/configPush this app's agent access settings - get
/{app_slug}/v1/agent-access/grantsList the app's agent connections (all end users) - delete
/{app_slug}/v1/agent-access/grants/{grant_id}Disconnect an end user's agent - post
/{app_slug}/v1/agent-access/introspectVerify an agent access token (RFC 7662 shape) - get
/{app_slug}/v1/me/agent-grantsList the signed-in user's connected agents - delete
/{app_slug}/v1/me/agent-grants/{grant_id}Disconnect an agent
Consumer-Auth
Sign your users up and in: password, passkey and code sign-in, MFA challenges and enrolment, token refresh and sign-out, email verification and password reset, invites and tenant switching.
- post
/{app_slug}/v1/auth/signupSign up an EndUser - post
/{app_slug}/v1/auth/accept-inviteAccept an EndUser invite by code - post
/{app_slug}/v1/auth/accept-tenant-inviteAccept a tenant invite by code - post
/{app_slug}/v1/auth/signinSign in an EndUser - post
/{app_slug}/v1/auth/mfa/send-codeEmail a sign-in code for an email MFA factor - post
/{app_slug}/v1/auth/mfa/verifyComplete an MFA challenge with a TOTP or emailed code - post
/{app_slug}/v1/auth/mfa/webauthn/optionsGet passkey assertion options for an open MFA challenge - post
/{app_slug}/v1/auth/passkey/optionsBegin a passwordless passkey sign-in - post
/{app_slug}/v1/auth/passkey/verifyComplete a passwordless passkey sign-in - get
/{app_slug}/v1/auth/email/configWhat a sign-in page needs to offer email sign-in - post
/{app_slug}/v1/auth/email/startStart a passwordless email sign-in (magic link or code) - post
/{app_slug}/v1/auth/email/verifyFinish a passwordless email sign-in with the code or the link - post
/{app_slug}/v1/auth/mfa/recoverComplete an MFA challenge with a recovery code - post
/{app_slug}/v1/auth/mfa/enrollBegin MFA enrolment against an enrolment token - post
/{app_slug}/v1/auth/mfa/enroll/verifyConfirm the enrolled factor and receive the withheld session - post
/{app_slug}/v1/auth/refreshExchange a refresh token for a new access token - post
/{app_slug}/v1/auth/logoutRevoke a refresh token - post
/{app_slug}/v1/auth/request-verificationMint a contact-verification code (PAK-required) - post
/{app_slug}/v1/auth/send-verification-emailMint + dispatch a verification email via Mail (PAK-required) - post
/{app_slug}/v1/auth/verifySubmit a verification code - post
/{app_slug}/v1/auth/request-password-resetMint a password-reset code (PAK-required) - post
/{app_slug}/v1/auth/send-password-reset-emailMint + dispatch a password-reset email via Mail (PAK-required) - post
/{app_slug}/v1/auth/reset-passwordSubmit a reset code + new password - post
/{app_slug}/v1/auth/switch-tenantSwitch the active tenant for this session - get
/{app_slug}/v1/auth/me/tenantsList the EndUser's tenant memberships in this app
Consumer-Me
The signed-in user: profile, avatar, password, sessions, activity, contacts and permissions, and closing the account.
- post
/{app_slug}/v1/me/tenant-invites/acceptAccept a tenant invite as the signed-in EndUser - get
/{app_slug}/v1/meGet the signed-in EndUser profile - patch
/{app_slug}/v1/meUpdate the signed-in EndUser profile - delete
/{app_slug}/v1/mePermanently delete the signed-in EndUser account - get
/{app_slug}/v1/me/permissionsResolve the signed-in EndUser's effective permissions - post
/{app_slug}/v1/me/avatarUpload (or replace) the EndUser avatar - delete
/{app_slug}/v1/me/avatarRemove the EndUser avatar - post
/{app_slug}/v1/me/change-passwordChange the password of the signed-in EndUser - get
/{app_slug}/v1/me/sessionsList all active sessions for the EndUser - delete
/{app_slug}/v1/me/sessions/{id}Revoke a session - get
/{app_slug}/v1/me/activityRecent account activity - get
/{app_slug}/v1/me/contactsList the EndUser's contacts - post
/{app_slug}/v1/me/contactsAdd a new contact (unverified, non-primary) - delete
/{app_slug}/v1/me/contacts/{id}Delete a contact - post
/{app_slug}/v1/me/contacts/{id}/promotePromote a verified contact to primary - get
/{app_slug}/v1/avatars/{account_id}Redirect to the current avatar image
Consumer-Mfa
The signed-in user's MFA: factors (TOTP, email codes, passkeys), recovery codes and step-up.
- get
/{app_slug}/v1/me/mfa/factorsList the authenticated EndUser's MFA factors - post
/{app_slug}/v1/me/mfa/factorsBegin enrollment of a new MFA factor - post
/{app_slug}/v1/me/mfa/factors/{id}/verifyConfirm enrollment of a pending factor - delete
/{app_slug}/v1/me/mfa/factors/{id}Disable an MFA factor - post
/{app_slug}/v1/me/mfa/recovery-codes/regenerateRegenerate the recovery-code set - post
/{app_slug}/v1/me/mfa/step-up/send-codeEmail a step-up code - post
/{app_slug}/v1/me/mfa/step-up/webauthn/optionsGet passkey assertion options for step-up - post
/{app_slug}/v1/me/mfa/step-upBump this session's MFA recency
Consumer-Oauth-M2m
OAuth 2.0 for machines: the client-credentials token endpoint and token introspection (RFC 7662).
Consumer-Oauth-Sign-In
Sign in with Google, GitHub or Apple: the native ID-token flow, and the code exchange that finishes the web redirect flow (the redirects themselves are browser routes).
- post
/{app_slug}/v1/auth/oauth/exchangeExchange a `heimdall_code` (received on the web-flow callback redirect) for Auth access + refresh tokens. - post
/{app_slug}/v1/auth/oauth/{provider}Sign in / sign up with a provider ID token (native flow) - get
/{app_slug}/v1/auth/oauth/{provider}/callbackProvider callback (Google / GitHub redirect with `code` on the query string). - post
/{app_slug}/v1/auth/oauth/{provider}/callbackProvider callback (Apple uses `response_mode=form_post`).
Consumer-Tenant-Api-Keys
Tenant API keys (`pctk_…`): your users manage keys for their tenant, and your backend introspects them and pushes the key settings.
- post
/{app_slug}/v1/tenant-api-keys/introspectVerify a tenant API key (RFC 7662 shape) - get
/{app_slug}/v1/tenant-api-keys/configRead this app's tenant API key settings - put
/{app_slug}/v1/tenant-api-keys/configPush this app's tenant API key settings - get
/{app_slug}/v1/tenant-api-keys/{key_id}/statusWhy a tenant API key is (in)active - get
/{app_slug}/v1/tenant-api-keysList the active tenant's API keys - post
/{app_slug}/v1/tenant-api-keysCreate an API key for the active tenant - post
/{app_slug}/v1/tenant-api-keys/{key_id}/rotateRotate an API key - delete
/{app_slug}/v1/tenant-api-keys/{key_id}Revoke an API key
Consumer-Tenants
Tenants (organisations inside your app) from your backend with a workspace API key: create, update and delete them, their members and invites.
- get
/{app_slug}/v1/tenantsList tenants in this app, paginated by created_at desc. - post
/{app_slug}/v1/tenantsCreate a tenant inside this app. - get
/{app_slug}/v1/tenants/{tenant_id}Fetch a single tenant by its UUID or `tnt_<12hex>` display id. - patch
/{app_slug}/v1/tenants/{tenant_id}Patch a tenant. - delete
/{app_slug}/v1/tenants/{tenant_id}Delete a tenant. - get
/{app_slug}/v1/tenants/{tenant_id}/membersList members of a tenant. - post
/{app_slug}/v1/tenants/{tenant_id}/membersAdd a member to a tenant. - patch
/{app_slug}/v1/tenants/{tenant_id}/members/{account_id}Change a member's role. - delete
/{app_slug}/v1/tenants/{tenant_id}/members/{account_id}Remove a member from a tenant. - get
/{app_slug}/v1/tenants/{tenant_id}/invitesList a tenant's invites, newest first. - post
/{app_slug}/v1/tenants/{tenant_id}/invitesInvite an email address into a tenant. - delete
/{app_slug}/v1/tenants/{tenant_id}/invites/{invite_id}Revoke a pending invite.
Consumer-Verify
Verify a user's access token and check its permissions from your backend, one check or a batch.