Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
Revoke a session
Revokes a session.
Revokes a session.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user/sessions/session:revoke - Scope
auth:write - Effect
destructive— a successful call removes data; the CLI asks before it runs. - Collection sessions
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the session. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/end_users/{end_user}/sessions/{session}. |
uid | string | ses_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
state | SessionState | The session state. Output only. One of active, revoked, expired. |
assurance | AuthMethod | How the session was established. Output only. One of password, magic_link, email_otp, passkey, totp, oidc, saml. |
mfa | bool | Whether a second factor was presented. Output only. |
active_organization | string | The active customer organization. Output only. |
oauth_client | string | The OAuth client the session signed in to, if any. Output only. |
ip_address | string | The client IP at sign-in. Output only. |
user_agent | string | The user agent at sign-in. Output only. |
last_active_time | timestamp | The last authenticated use. Output only. |
expire_time | timestamp | When the session expires. Output only. |
revoke_time | timestamp | When the session was revoked. Output only. |
revoke_reason | SessionRevokeReason | Why the session was revoked. Output only. One of sign_out, user, admin, session_limit, recovery, suspended, deleted, fingerprint. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user/sessions/session:revoke" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'