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

Get a service account

Returns one service account by id: its name, description, role, whether it is disabled, how many unrevoked API keys it holds, and who created it and when.

Required permission

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

Command line

The orl CLI wraps this endpoint:

orl service-accounts get <service-account-id>
GET
/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

The service account

application/json
  1. response
id*string
name*string
description?string
roleId*string
roleName?string
disabled*boolean

A disabled account's keys are denied every request.

keyCount*integer

Live keys the account holds.

createdBy*string
createdAt*string
Example Request
curl -X GET 'https://api.openrelay.inc/v1/service-accounts/string'
Example Response
{  "id": "string",  "name": "string",  "description": "string",  "roleId": "string",  "roleName": "string",  "disabled": true,  "keyCount": 0,  "createdBy": "string",  "createdAt": "string"}

Create a service account POST

Creates an organization-owned identity with a role, for API keys not tied to a person. It cannot hold the Owner role; an org may have at most 200. Requires a signed-in session. Its role must be within the creator's own access.

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.