Remove one of the signed-in user's passkeys
Requires the user's login token.
Warning
Not fully described yet. The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.
DELETE/api/v1/auth/passkey/id
- Sign-in
- A login token from hosted sign-in as a Bearer token, and the organization in the state header or the org query parameter.
- Rate limit
- Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 30 requests a minute per IP address.
Requires the user's login token. Answers 404 when the passkey is not the user's, 409 when it is the last passkey the person's company requires, and 403 when the company requires a recent passkey sign-in before removing one.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
id | string | Yes | - | - |
Example request
Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.
curl -X DELETE "https://api.console.buildbase.app/api/v1/auth/passkey/YOUR_ID?org=YOUR_ORG_ID" \
-H "Authorization: Bearer $BUILDBASE_LOGIN_TOKEN"const response = await fetch(
'https://api.console.buildbase.app/api/v1/auth/passkey/YOUR_ID?org=YOUR_ORG_ID',
{
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.BUILDBASE_LOGIN_TOKEN}`,
},
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();import os
import requests
response = requests.delete(
"https://api.console.buildbase.app/api/v1/auth/passkey/YOUR_ID?org=YOUR_ORG_ID",
headers={
"Authorization": "Bearer " + os.environ["BUILDBASE_LOGIN_TOKEN"],
},
timeout=30,
)
response.raise_for_status()
data = response.textResponses
A successful answer is not described yet. The server answers with the status and body its handler sends.
Any other status
The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).
Errors
Each refusal, what it means, and what to do. The request changed nothing.
401 Unauthorized
What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.
What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.
Unauthorized429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- Auth guide: how this part of BuildBase works
- All Auth operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
auth.passkey.deletein public-v1.json