NAnace
Workspaces

Save a connection's credentials

The IAM role ARN, or the Azure service principal and its secret, Nace uses to reach the destination. Write-only: they are never returned, and a refusal never quotes them. The connection has credentials_pending until a validation passes. Free. Only where customer storage is on for the deployment; where it is off, every storage connection route answers 404 storage_connection_unavailable once the API key is accepted, before checking the request or its body.

put/v1/storage-connections/{id}/credentials

Request

Path parameters

idstring uuid required

The connection's id.

Request body

OR

Response

The connection, with credentials_pending true.

idstring uuid required

The id a workspace create takes as storage.connection_id.

namestring required
status'draft' | 'ready' | 'degraded' | 'revoked' required

draft until a validation passes, ready once Nace can use it, degraded when a later check failed, revoked once access was taken away.

can_manageboolean required

Whether this key may change the connection: its creator's, or an owner's or admin's.

external_idstring required

The external id your IAM role's trust policy must require.

aws_trusted_principal_arnstring nullable

Older single trusted role; use aws_trusted_principal_arns.

aws_trusted_principal_arnsstring[]

Every Nace IAM role your trust policy must allow; empty for Azure.

credentials_pendingboolean

Saved credentials still need a validation to pass.

validation_runningboolean

A validation job is running.

credential_generationinteger required

Counts credential changes.

validated_atstring date-time nullable

When a validation last passed.

reactivation_requires_approvalboolean

Nace revoked it: only Nace support can let it be validated again.

revoked_reason'owner' | 'administrator' | 'member_removed' | 'user_disabled' | 'null' nullable
revoked_atstring date-time nullable
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.