Skip to content

ServiceUser

Machine accounts for API-only access, used for automation and integrations. Each service user can have API tokens generated without portal access. Requires users::read to view.

Operations

Retrieve configuration details for a specific service account

Request

Security
JWTAuthorizer
Path
namestringrequired

The name of the service user

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/service-user/{name}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A service user

Bodyapplication/json
namestring

Service account name (used as identifier)

statusstring

Whether the service account is active

Enum:"active""inactive"
clientIdstring

Client ID used for API authentication (present after token generation)

policyIdsArray of strings

Named policy IDs attached to this service account

Example:
[
  "builtin-tg-monitor"
]
tokenCreatedinteger

Unix epoch timestamp (seconds) when the API token was last generated

orgIdstring

Organization ID

Response
{
  "name": "string",
  "status": "active",
  "clientId": "string",
  "policyIds": [
    "builtin-tg-monitor"
  ],
  "tokenCreated": 0,
  "orgId": "string"
}