NGngrok
ServiceUsers

Update

Changed on

Update attributes of a service user by ID.

patch/service_users/{id}

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/service_users/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Headers

ngrok-versioninteger required

Request body

idstring

n/a

namestring

human-readable name used to identify the service

activeboolean

whether or not the service is active

rolesstring[]

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.

idstring

unique API key resource identifier

uristring

URI to the API resource of this service user

namestring

human-readable name used to identify the service

activeboolean

whether or not the service is active

created_atstring

timestamp when the api key was created, RFC 3339 format

rolesstring[]

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.

Changes