Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version
integer
default:2
required

Path Parameters

id
string
required

Body

application/json
id
string

n/a

name
string

human-readable name used to identify the service

active
boolean

whether or not the service is active

roles
string[]

roles that replace the service user's current roles. Any choice other than developer needs a plan with role-based access control.

Response

Update attributes of a service user by ID.

id
string

unique API key resource identifier

uri
string

URI to the API resource of this service user

name
string

human-readable name used to identify the service

active
boolean

whether or not the service is active

created_at
string

timestamp when the api key was created, RFC 3339 format

roles
string[]

roles the service user holds, in a fixed order. Accepts developer, developer-readonly, and team-manager. Roles limit the service user's access tokens. They do not limit its API keys.