Skip to content
Open Console →

Machine users

6 endpoints under /api/v1/machine-users.

GET /api/v1/machine-users #

List the organization's machine users (and their tokens)

Responses

200 Automation identities of the active organization.
Response body
  • machineUsersMachineUser[]required
    Show fields
    • userIdstringrequired
    • namestringrequired
    • createdBystringrequired
    • createdAtstring · date-timerequired
    • tokensMachineToken[]required
      Show fields
      • idstringrequired
      • namestringrequired
      • startstringrequired
      • enabledbooleanrequired
      • createdAtstring · date-timerequired
      • expiresAtstring · date-timerequired
      • lastRequeststring · date-timerequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires an owner/admin of the organization.
Response body
  • errorstringrequired
404 Unknown machine user or token.
Response body
  • errorstringrequired
POST /api/v1/machine-users #

Create a machine user

Request body

  • namestringrequired

Responses

201 Created — a credential-less identity; mint tokens to use it.
Response body
  • userIdstringrequired
  • namestringrequired
  • createdBystringrequired
  • createdAtstring · date-timerequired
  • tokensMachineToken[]required
    Show fields
    • idstringrequired
    • namestringrequired
    • startstringrequired
    • enabledbooleanrequired
    • createdAtstring · date-timerequired
    • expiresAtstring · date-timerequired
    • lastRequeststring · date-timerequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires an owner/admin of the organization.
Response body
  • errorstringrequired
404 Unknown machine user or token.
Response body
  • errorstringrequired
DELETE /api/v1/machine-users/{id} #

Delete a machine user (and all its tokens)

Parameters

  • id path string required

Responses

204 Deleted.
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires an owner/admin of the organization.
Response body
  • errorstringrequired
404 Unknown machine user or token.
Response body
  • errorstringrequired
POST /api/v1/machine-users/{id}/tokens #

Mint a token for a machine user

Parameters

  • id path string required

Request body

  • namestringrequired
  • expiresIninteger

Responses

201 The token — shown once, store it safely.
Response body
  • idstringrequired
  • keystringrequired
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires an owner/admin of the organization.
Response body
  • errorstringrequired
404 Unknown machine user or token.
Response body
  • errorstringrequired
PATCH /api/v1/machine-users/{id}/tokens/{tokenId} #

Deactivate or reactivate a machine token

Parameters

  • id path string required
  • tokenId path string required

Request body

  • enabledbooleanrequired

Responses

204 Updated.
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires an owner/admin of the organization.
Response body
  • errorstringrequired
404 Unknown machine user or token.
Response body
  • errorstringrequired
DELETE /api/v1/machine-users/{id}/tokens/{tokenId} #

Delete a machine token

Parameters

  • id path string required
  • tokenId path string required

Responses

204 Deleted.
401 Unauthenticated.
Response body
  • errorstringrequired
403 Requires an owner/admin of the organization.
Response body
  • errorstringrequired
404 Unknown machine user or token.
Response body
  • errorstringrequired