NGngrok
ServiceUsers

Create

Changed on

Create a new service user

post/service_users

Request

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

Headers

ngrok-versioninteger required

Request body

namestring

human-readable name used to identify the service

activeboolean

whether or not the service is active

rolesstring[]

roles the service user holds. Defaults to developer. Any other choice needs a plan with role-based access control.

Response

Create a new service user

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