Skip to content
Proud to collaborate with Microsoft for Startups

identity.api-token.update ​

Rename an API token belonging to the current user

Rename one of the current user's API tokens.

Inputs:

  • token_uuid: public uuid of the token (required)
  • actor: Cognito sub or user UUID (required)
  • name: new token name (required, 1..128 chars, must be unique per user)

Outputs (terminal state_data):

  • token_uuid
  • updated: bool
  • name: the new name

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
token_uuidstringYes——
actorstringYes——
namestringYes——
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
token_uuidstringYes——
updatedbooleanYes——
namestringNo——
actorstringNo——
organization_uuiduuidNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "identity.api-token.update",
  "initial_data": {
    "token_uuid": "value",
    "actor": "value",
    "name": "value"
  }
}