# Faable API

**Canonical:** https://apis.io/apis/faable-com/faable-com-api/  
**Provider:** Faable — https://apis.io/providers/faable-com/  
**Documentation:** https://faable.com/docs/auth/apis

Faable API is one of 2 APIs that [Faable](https://apis.io/providers/faable-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Faable API as documented publicly: 83 operations. Contract generated from the documentation by API Evangelist (2026-11-07); not the provider's own document.

## Operations (60 of 83)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | GET / |
| GET | `/.well-known/jwks.json` | The public keys are published at: GET https://your-tenant.faable.app/.well-known/jwks.json. |
| GET | `/.well-known/openid-configuration` | Each tenant publishes its configuration at the standard well-known URL. |
| POST | `/account` | POST /account |
| GET | `/account/keys/saml` | Get the current SAML signing certificate, and the staged one if present. |
| POST | `/account/keys/saml/rotate` | Rotate the signing certificate (stage a new certificate). |
| POST | `/api/api_xxx` | Define the permissions on the API, and enable RBAC |
| GET | `/apis` | List APIs (paginated, FaableQL-filterable). |
| POST | `/apis` | Create an API. |
| DELETE | `/apis/{apisId}` | Delete. |
| GET | `/apis/{apisId}` | Read one. |
| POST | `/apis/{apisId}` | Update. |
| POST | `/auth/backchannel-logout` | POST /auth/backchannel-logout Receives the tenant’s logout_token, verifies it, and ends the session it names. |
| GET | `/auth/callback` | GET /auth/callback Exchanges the code, verifies the id_token, sets the session cookie, redirects to returnTo. |
| GET | `/auth/login` | GET /auth/login Starts the login. |
| GET | `/auth/logout` | GET /auth/logout Clears the cookie and sends the browser through the tenant’s /logout (with id_token_hint), so the SSO session ends and every other app is told. |
| GET | `/authorize` | Redirect the User to /authorize |
| GET | `/change-email-verify` | Public entry point for the link in the verification email. |
| POST | `/client` | Create a new client programmatically. |
| GET | `/client/{id}` | Retrieve a client by its ID via the Management API. |
| POST | `/client/{id}` | Set management_scopes on POST /client/:id |
| POST | `/clients` | Register client logout fields via POST /clients |
| GET | `/connections` | Retrieve a list of connections, optionally filtered by category |
| GET | `/deploy` | GET /deploy |
| POST | `/hooks/faable` | Delivery format for Faable webhook events |
| GET | `/invite-verify` | Default target of the email link. |
| GET | `/log` | Retrieve tenant log entries, filterable by query parameters |
| GET | `/logout` | RP-Initiated Logout |
| POST | `/logout/confirm` | Confirm a pending logout |
| GET | `/logs` | List logs (paginated). |
| GET | `/logs/{logId}` | Fetch a single log entry. |
| DELETE | `/me` | Delete the user’s account. |
| GET | `/me` | GET /me returns the user's profile. |
| PATCH | `/me` | Update the name, company, country and your app’s custom fields. |
| GET | `/me/credentials` | Whether the user has a password, and the connections they use. |
| DELETE | `/me/identities/{connectionId}` | Unlink one of the user’s social or enterprise accounts. |
| POST | `/me/password` | Set or change the user’s password. |
| GET | `/me/sessions` | List the user’s active sessions. |
| POST | `/me/sessions/revoke-others` | Sign the user out everywhere else. |
| POST | `/oauth/device/code` | POST /oauth/device/code |
| POST | `/oauth/grant-type/mfa-otp` | POST /oauth/grant-type/mfa-otp |
| GET | `/oauth/token` | GET /oauth/token |
| POST | `/oauth/token` | Obtain tokens by authenticating the client at the token endpoint. |
| POST | `/oidc/register` | POST /oidc/register |
| GET | `/orders` | GET /orders |
| POST | `/passwordless/start` | Start the flow. Sends a link or a code to the email. |
| GET | `/passwordless/verify_redirect` | Public entry point for the magic link. Verifies, issues a session, and redirects to the client. |
| GET | `/projects` | GET /projects |
| POST | `/role` | Create a role and give it permissions |
| DELETE | `/role/{roleId}/permissions` | Remove permissions from a role |
| GET | `/role/{roleId}/permissions` | Get the role’s permissions |
| POST | `/role/{roleId}/permissions` | Add permissions to a role |
| DELETE | `/role/{roleId}/users` | Remove users from a role |
| GET | `/role/{roleId}/users` | Get users holding the role at the account level |
| POST | `/role/{roleId}/users` | Assign users to a role |
| GET | `/saml/metadata/{clientId}` | IdP metadata: entity ID, single sign-on URL and signing certificates. |
| POST | `/saml/sso/{clientId}` | Single sign-on (HTTP-Redirect and HTTP-POST bindings). |
| GET | `/session` | List sessions (paginated, FaableQL filterable). |
| GET | `/session/{sessionId}` | One session. |
| POST | `/session/{sessionId}/revoke` | Revoke it. |

…and 23 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/faable-com/openapi/_ae-authored/faable-com-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/faable-com/json-schema/faable-com-post-apis-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/faable-com/json-schema/faable-com-post-apis-apisid-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/faable-com/json-schema/faable-com-get-logs-logid-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/faable-com/json-schema/faable-com-get-well-known-openid-configuration-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/faable-com/json-schema/faable-com-post-team-teamid-invite-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/faable-com/json-schema/faable-com-post-passwordless-start-request-schema.json

## Other Faable APIs (1)

- [Faable Deploy & Auth](https://apis.io/apis/faable-com/faable-deploy-auth/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/faable-com/faable-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/faable-com/.