github.auth.validate_installation ​
Generate a GitHub App installation access token
Authenticate as a GitHub App installation and return a short-lived access token.
Uses the GitHub App's private key to sign a JWT, then exchanges it for an installation access token valid for 1 hour.
Inputs:
- installation_id: GitHub App installation ID (required). Found in the GitHub App settings or the installation webhook payload.
Outputs (terminal state_data):
- token: str — installation access token (use as Bearer in subsequent requests)
- expires_at: str — ISO-8601 expiry timestamp (1 hour from creation)
- installation_id: str | int — echoed back
Plugin required: context.get_plugin("github") must expose:
- .app_id — GitHub App ID (integer or string)
- .private_key_pem — RSA private key in PEM format (str)
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
installation_id | string | Yes | — | GitHub App installation ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
expires_at | string | No | — | — |
installation_id | string | No | — | — |
token | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.auth.validate_installation",
"initial_data": {
"installation_id": "value"
}
}