Skip to content
Proud to collaborate with Microsoft for Startups

netlify.auth.validate_token ​

Validate a Netlify personal access token

Validate a Netlify personal access token and return the authenticated user.

Inputs: none (token comes from the netlify plugin).

Outputs (terminal state_data):

  • user_id: str — Netlify user ID
  • email: str — account email
  • name: str | None — display name
  • authenticated: bool — always true on success

Plugin required: context.get_plugin("netlify") must expose .api_token.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-netlify
Version1.0

Input Schema ​

No input fields required.

Output Schema ​

FieldTypeRequiredDefaultDescription
authenticatedbooleanNo——
emailstringNo——
namestringNo——
user_idstringNo——
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": "netlify.auth.validate_token",
  "initial_data": { }
}