perpetual credential
Manage credentials (secrets connectors use; written live).
perpetual credential create
Create a credential.
perpetual credential create [flags]
Changes: Writes live, outside any changeset. Credentials hold secret material, which never lives in a manifest or a changeset. The API has no staged form for them.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--type | string | Required | Credential type (Text, OAuth2ClientCredentials, HmacSignature, AwsRole, OAuth2AuthorizationCode); create OAuth2AuthorizationCode in the web app. |
--name | string | Required | Credential name (letters, digits and underscores). |
--description | string | Optional | Credential description. |
--allowed-urls | string, repeatable | Optional | URL patterns the credential may be sent to, comma-separated or repeated (e.g. *.example.com,api.example.com/v1/*). |
--space-id | string | Optional | Scope the credential to this space. |
--org-wide | boolean | Optional | Make the credential usable across the entire organization. |
--token-url | string | Optional | Token endpoint URL (required on create) (OAuth2ClientCredentials). |
--client-id | string | Optional | OAuth client ID (required on create) (OAuth2ClientCredentials). |
--scopes | string | Optional | Space-separated OAuth scopes (OAuth2ClientCredentials). |
--audience | string | Optional | Token audience (OAuth2ClientCredentials). |
--token-endpoint-auth-method | string | Optional | How the client authenticates to the token endpoint (client_secret_basic, client_secret_post, none) (OAuth2ClientCredentials). |
--algorithm | string | Optional | Signature algorithm (sha1, sha256, sha512) (HmacSignature). |
--signature-format | string | Optional | Signature encoding (hex, base64) (HmacSignature). |
--include-timestamp | string | Optional | Sign a timestamp too (true or false) (HmacSignature). |
--timestamp-header | string | Optional | Header that carries the signed timestamp (HmacSignature). |
--role-arn | string | Optional | ARN of the IAM role to assume (required on create) (AwsRole). |
--external-id | string | Optional | External ID the role's trust policy requires (required on create) (AwsRole). |
--region | string | Optional | AWS region (AwsRole). |
--secret-stdin | boolean | Optional | Read the secret from stdin (one trailing newline is dropped). |
--secret-env | string | Optional | Read the secret from this environment variable, used exactly as set. |
--value | string | Optional | Not accepted: pass the secret with --secret-stdin or --secret-env. |
--secret | string | Optional | Not accepted: pass the secret with --secret-stdin or --secret-env. |
--client-secret | string | Optional | Not accepted: pass the secret with --secret-stdin or --secret-env. |
Also accepts the global flags, including the sign-in flags.
perpetual credential delete
Delete a credential.
perpetual credential delete <id> [flags]
Changes: Writes live, outside any changeset. Credentials hold secret material, which never lives in a manifest or a changeset. The API has no staged form for them.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Credential ID (CRD_…). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--force | boolean | Optional | Skip confirmation prompt (required in non-interactive mode). |
Also accepts the global flags, including the sign-in flags.
perpetual credential get
Get a credential (never its secret).
perpetual credential get <id>
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Credential ID (CRD_…). |
Also accepts the global flags, including the sign-in flags.
perpetual credential list
List credentials.
perpetual credential list [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--space-id | string | Optional | Only credentials usable from this space, organization-wide ones included. |
--top | string | Optional | Items per page (server default 100). |
--skip | string | Optional | Number of items to skip. |
--all | boolean | Optional | Fetch every page (1000 items per request). |
Also accepts the global flags, including the sign-in flags.
perpetual credential update
Update a credential; an omitted secret stays unchanged.
perpetual credential update <id> [flags]
Changes: Writes live, outside any changeset. Credentials hold secret material, which never lives in a manifest or a changeset. The API has no staged form for them.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Credential ID (CRD_…). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--name | string | Optional | New credential name. |
--description | string | Optional | Credential description. |
--allowed-urls | string, repeatable | Optional | URL patterns the credential may be sent to, comma-separated or repeated (e.g. *.example.com,api.example.com/v1/*). |
--token-url | string | Optional | Token endpoint URL (required on create) (OAuth2ClientCredentials). |
--client-id | string | Optional | OAuth client ID (required on create) (OAuth2ClientCredentials). |
--scopes | string | Optional | Space-separated OAuth scopes (OAuth2ClientCredentials). |
--audience | string | Optional | Token audience (OAuth2ClientCredentials). |
--token-endpoint-auth-method | string | Optional | How the client authenticates to the token endpoint (client_secret_basic, client_secret_post, none) (OAuth2ClientCredentials). |
--algorithm | string | Optional | Signature algorithm (sha1, sha256, sha512) (HmacSignature). |
--signature-format | string | Optional | Signature encoding (hex, base64) (HmacSignature). |
--include-timestamp | string | Optional | Sign a timestamp too (true or false) (HmacSignature). |
--timestamp-header | string | Optional | Header that carries the signed timestamp (HmacSignature). |
--role-arn | string | Optional | ARN of the IAM role to assume (required on create) (AwsRole). |
--external-id | string | Optional | External ID the role's trust policy requires (required on create) (AwsRole). |
--region | string | Optional | AWS region (AwsRole). |
--secret-stdin | boolean | Optional | Read the secret from stdin (one trailing newline is dropped). |
--secret-env | string | Optional | Read the secret from this environment variable, used exactly as set. |
--value | string | Optional | Not accepted: pass the secret with --secret-stdin or --secret-env. |
--secret | string | Optional | Not accepted: pass the secret with --secret-stdin or --secret-env. |
--client-secret | string | Optional | Not accepted: pass the secret with --secret-stdin or --secret-env. |
Also accepts the global flags, including the sign-in flags.
Perpetual CLI 0.5.0