TRANXACT.AI Help

Platform · Access

Service Accounts

Identities for software. They hold roles like a person but cannot sign in to the console and are never asked for a second step: a secret, shown once, is exchanged for a short-lived token.

Type REST6 operationsBase path /api/platform/service-accounts

Download specification (OpenAPI 3.1) Screen: Service Accounts

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Platform › Service Accounts on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/platform/service-accountsRead service accounts

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/platform/service-accounts" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/service-accountsPost service accounts

Request body

The keys this action reads (* = required; "one of" lists the only values):

roles, email, name, description, tokenMinutes, allowedIps, expiresAt

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/service-accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"roles":"value","email":"value","name":"value","description":"value","tokenMinutes":"value","allowedIps":"value"}'
PUT/api/platform/service-accounts/{id}Put service accounts

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

roles, description, allowedIps, tokenMinutes, expiresAt, name, active

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/platform/service-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"roles":"value","description":"value","allowedIps":"value","tokenMinutes":"value","expiresAt":"value","name":"value"}'
POST/api/platform/service-accounts/{id}/rotateRotate

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/service-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rotate" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/service-accounts/{id}/revokeRevoke

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/platform/service-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/revoke" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/platform/service-accounts/{id}Delete service accounts

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/platform/service-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › Service Accounts for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.