Skip to content
Proud to collaborate with Microsoft for Startups

github.git.repository-credential-lease ​

Issue one repository-scoped read credential to a fenced trusted runner.

Mint a one-time read credential for one repository owned by an active runner workspace or environment build lease.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-github
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
repository_uuiduuidYes——
runner_execution_uuiduuidNo——
runner_instance_uuiduuidNo——
workspace_lease_uuiduuidNo——
environment_build_uuiduuidNo——
environment_build_lease_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
repository_uuiduuidYes——
runner_execution_uuiduuidNo——
runner_instance_uuiduuidNo——
workspace_lease_uuiduuidNo——
environment_build_uuiduuidNo——
environment_build_lease_uuiduuidNo——
binding_uuiduuidYes——
broker_binding_keystringYes——
providerstringYes——
repositorystringYes——
usernamestringYes——
tokenstringYes——
expires_atstringYes——
scopelistYes——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_stepstringNo——
failed_layerstringNo——
failed_at_statestringNo——
errorstringNo——
error_typestringNo——
failed_atstringNo——

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": "github.git.repository-credential-lease",
  "initial_data": {
    "organization_uuid": "value",
    "repository_uuid": "value"
  }
}