argocd.repository.validate-write-access

ValidateWriteAccess validates write access to a repository with given parameters

Overview

Property	Value
Workflow type	Atomic
Library	App-argocd
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Argocd API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
repo	string	Yes	—	The URL to the repo
body	json	Yes	—	The URL to the repo
username	string	No	—	Username for accessing repo.
password	string	No	—	Password for accessing repo.
sshprivatekey	string	No	—	Private key data for accessing SSH repository.
insecure	boolean	No	—	Whether to skip certificate or host key validation.
tlsclientcertdata	string	No	—	TLS client cert data for accessing HTTPS repository.
tlsclientcertkey	string	No	—	TLS client cert key for accessing HTTPS repository.
type	string	No	—	The type of the repo.
name	string	No	—	The name of the repo.
enableoci	boolean	No	—	Whether helm-oci support should be enabled for this repo.
githubappprivatekey	string	No	—	Github App Private Key PEM data.
githubappid	string	No	—	Github App ID of the app used to access the repo.
githubappinstallationid	string	No	—	Github App Installation ID of the installed GitHub App.
githubappenterprisebaseurl	string	No	—	Github App Enterprise base url if empty will default to https://api.github.com.
proxy	string	No	—	HTTP/HTTPS proxy to access the repository.
project	string	No	—	Reference between project and repository that allow you automatically to be added as item inside SourceRepos project entity.
gcpserviceaccountkey	string	No	—	Google Cloud Platform service account key.
forcehttpbasicauth	boolean	No	—	Whether to force HTTP basic auth.
useazureworkloadidentity	boolean	No	—	Whether to use azure workload identity for authentication.
bearertoken	string	No	—	BearerToken contains the bearer token used for Git auth at the repo server.
insecureociforcehttp	boolean	No	—	Whether https should be disabled for an OCI repo.
azureserviceprincipalclientid	string	No	—	Azure Service Principal Client ID.
azureserviceprincipalclientsecret	string	No	—	Azure Service Principal Client Secret.
azureserviceprincipaltenantid	string	No	—	Azure Service Principal Tenant ID.
azureactivedirectoryendpoint	string	No	—	Azure Active Directory Endpoint.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Argocd API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
repo	string	Yes	—	The URL to the repo
body	json	Yes	—	The URL to the repo
username	string	No	—	Username for accessing repo.
password	string	No	—	Password for accessing repo.
sshprivatekey	string	No	—	Private key data for accessing SSH repository.
insecure	boolean	No	—	Whether to skip certificate or host key validation.
tlsclientcertdata	string	No	—	TLS client cert data for accessing HTTPS repository.
tlsclientcertkey	string	No	—	TLS client cert key for accessing HTTPS repository.
type	string	No	—	The type of the repo.
name	string	No	—	The name of the repo.
enableoci	boolean	No	—	Whether helm-oci support should be enabled for this repo.
githubappprivatekey	string	No	—	Github App Private Key PEM data.
githubappid	string	No	—	Github App ID of the app used to access the repo.
githubappinstallationid	string	No	—	Github App Installation ID of the installed GitHub App.
githubappenterprisebaseurl	string	No	—	Github App Enterprise base url if empty will default to https://api.github.com.
proxy	string	No	—	HTTP/HTTPS proxy to access the repository.
project	string	No	—	Reference between project and repository that allow you automatically to be added as item inside SourceRepos project entity.
gcpserviceaccountkey	string	No	—	Google Cloud Platform service account key.
forcehttpbasicauth	boolean	No	—	Whether to force HTTP basic auth.
useazureworkloadidentity	boolean	No	—	Whether to use azure workload identity for authentication.
bearertoken	string	No	—	BearerToken contains the bearer token used for Git auth at the repo server.
insecureociforcehttp	boolean	No	—	Whether https should be disabled for an OCI repo.
azureserviceprincipalclientid	string	No	—	Azure Service Principal Client ID.
azureserviceprincipalclientsecret	string	No	—	Azure Service Principal Client Secret.
azureserviceprincipaltenantid	string	No	—	Azure Service Principal Tenant ID.
azureactivedirectoryendpoint	string	No	—	Azure Active Directory Endpoint.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call POST /api/v1/write-repositories/{repo}/validate
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform POST /api/v1/write-repositories/{repo}/validate
* (any state)	fail	failed	Record the failure reason

API Usage

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

{
  "workflow_type": "argocd.repository.validate-write-access",
  "initial_data": {
    "base_url": "value",
    "repo": "value",
    "body": "value"
  }
}