Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceAccount and accessService Accounts

Delete a service account and revoke its keys

Deletes a service account and revokes every API key it holds, returning the revoked key ids. The keys stop working when the account is deleted. Requires a signed-in session.

Required permission

Requires the serviceaccount.manage permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl service-accounts delete <service-account-id>
DELETE
/v1/service-accounts/{serviceAccountId}

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

serviceAccountId*string

Response Body

Deleted

application/json
  1. response
revokedKeyIds*array<string>
Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/service-accounts/string'
Example Response
{  "revokedKeyIds": [    "string"  ]}

Update, disable or enable a service account PATCH

Changes a service account's name, description, role or disabled state and returns it. A new role, or enabling the account again, must be within your own access. Requires a signed-in session. Disabling denies every request its keys make until it is enabled again.

Overview

The permission catalog, effective access, the access checker, guardrails, Cedar policies and key settings such as the maximum key lifetime. Available to organizations with permissions enabled; otherwise these endpoints return 404.