gcp.sql.user.ensure

Create or update a PostgreSQL user in Cloud SQL.

Overview

Property	Value
Workflow type	Linear
Library	Base-gcp
Version	1.0

Input Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	Yes	—	GCP CloudConnection UUID.
project_id	string	No	—	GCP project override.
instance_id	string	Yes	—	Cloud SQL instance id.
username	string	Yes	—	Database user name.
password	string	No	—	Password to set; generated by caller when omitted.
host	string	No	—	Cloud SQL host field, defaults to %.
update_password	boolean	No	—	Whether to update password for existing user.

Output Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	No	—	Echoed connection UUID.
project_id	string	No	—	Effective project.
instance_id	string	No	—	Cloud SQL instance id.
username	string	No	—	User name.
host	string	No	—	User host.
update_password	boolean	No	—	Whether to update password for existing user.
created	boolean	No	—	True when created during this run.
password_set	boolean	No	—	True when password was set or updated.
user	json	No	—	Sanitized user response without password.
failure_reason	string	No	—	Human-readable failure reason.
failed_step	string	No	—	Failed logical step.
failed_layer	json	No	—	Engine failed layer.
failed_at_state	string	No	—	State where failure occurred.
error	string	No	—	Error message.
error_type	string	No	—	Error class.

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	—
ensuring	No	No	—	complete	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	execute	ensuring	—
ensuring	complete	completed	—
* (any state)	fail	failed	—

API Usage

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

{
  "workflow_type": "gcp.sql.user.ensure",
  "initial_data": {
    "connection_uuid": "value",
    "instance_id": "value",
    "username": "value"
  }
}