Skip to main content

WorkflowAuthPrincipal

kindWorkflowAuthPrincipalKindrequired

Possible values: [admin_key, admin_session, user_session, api_key]

userIdstring
displayNamestring
emailstring<email>
permissionsWorkflowPermissionKey[]

Possible values: [system.admin, users.read, users.manage, roles.read, roles.manage, api_keys.manage_self, api_keys.manage_all, projects.create, projects.read_public, projects.read_all, projects.manage_own, projects.manage_all, projects.delete, projects.upload, projects.publish, projects.download_source, runs.create, runs.read_own, runs.read_project, runs.cancel, env.manage, kv.read, knowledge.manage, embed.manage, webhook.manage, run_queue.manage, schedule.manage, terminal.use, audit.read, audit.export]

apiKeyIdstring
expiresAtstring<date-time>

The current API Key expiration. A successfully authenticated Desktop Key uses sliding renewal.

roleNamesstring[]
WorkflowAuthPrincipal
{
  "kind": "admin_key",
  "userId": "string",
  "displayName": "string",
  "email": "user@example.com",
  "permissions": [
    "system.admin"
  ],
  "apiKeyId": "string",
  "expiresAt": "2024-07-29T15:51:28.071Z",
  "roleNames": [
    "string"
  ]
}