Skip to main content

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​

FlagTypeRequiredDescription
--typestringRequiredCredential type (Text, OAuth2ClientCredentials, HmacSignature, AwsRole, OAuth2AuthorizationCode); create OAuth2AuthorizationCode in the web app.
--namestringRequiredCredential name (letters, digits and underscores).
--descriptionstringOptionalCredential description.
--allowed-urlsstring, repeatableOptionalURL patterns the credential may be sent to, comma-separated or repeated (e.g. *.example.com,api.example.com/v1/*).
--space-idstringOptionalScope the credential to this space.
--org-widebooleanOptionalMake the credential usable across the entire organization.
--token-urlstringOptionalToken endpoint URL (required on create) (OAuth2ClientCredentials).
--client-idstringOptionalOAuth client ID (required on create) (OAuth2ClientCredentials).
--scopesstringOptionalSpace-separated OAuth scopes (OAuth2ClientCredentials).
--audiencestringOptionalToken audience (OAuth2ClientCredentials).
--token-endpoint-auth-methodstringOptionalHow the client authenticates to the token endpoint (client_secret_basic, client_secret_post, none) (OAuth2ClientCredentials).
--algorithmstringOptionalSignature algorithm (sha1, sha256, sha512) (HmacSignature).
--signature-formatstringOptionalSignature encoding (hex, base64) (HmacSignature).
--include-timestampstringOptionalSign a timestamp too (true or false) (HmacSignature).
--timestamp-headerstringOptionalHeader that carries the signed timestamp (HmacSignature).
--role-arnstringOptionalARN of the IAM role to assume (required on create) (AwsRole).
--external-idstringOptionalExternal ID the role's trust policy requires (required on create) (AwsRole).
--regionstringOptionalAWS region (AwsRole).
--secret-stdinbooleanOptionalRead the secret from stdin (one trailing newline is dropped).
--secret-envstringOptionalRead the secret from this environment variable, used exactly as set.
--valuestringOptionalNot accepted: pass the secret with --secret-stdin or --secret-env.
--secretstringOptionalNot accepted: pass the secret with --secret-stdin or --secret-env.
--client-secretstringOptionalNot 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​

ArgumentRequiredDescription
idRequiredCredential ID (CRD_…).

Flags​

FlagTypeRequiredDescription
--forcebooleanOptionalSkip 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​

ArgumentRequiredDescription
idRequiredCredential 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​

FlagTypeRequiredDescription
--space-idstringOptionalOnly credentials usable from this space, organization-wide ones included.
--topstringOptionalItems per page (server default 100).
--skipstringOptionalNumber of items to skip.
--allbooleanOptionalFetch 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​

ArgumentRequiredDescription
idRequiredCredential ID (CRD_…).

Flags​

FlagTypeRequiredDescription
--namestringOptionalNew credential name.
--descriptionstringOptionalCredential description.
--allowed-urlsstring, repeatableOptionalURL patterns the credential may be sent to, comma-separated or repeated (e.g. *.example.com,api.example.com/v1/*).
--token-urlstringOptionalToken endpoint URL (required on create) (OAuth2ClientCredentials).
--client-idstringOptionalOAuth client ID (required on create) (OAuth2ClientCredentials).
--scopesstringOptionalSpace-separated OAuth scopes (OAuth2ClientCredentials).
--audiencestringOptionalToken audience (OAuth2ClientCredentials).
--token-endpoint-auth-methodstringOptionalHow the client authenticates to the token endpoint (client_secret_basic, client_secret_post, none) (OAuth2ClientCredentials).
--algorithmstringOptionalSignature algorithm (sha1, sha256, sha512) (HmacSignature).
--signature-formatstringOptionalSignature encoding (hex, base64) (HmacSignature).
--include-timestampstringOptionalSign a timestamp too (true or false) (HmacSignature).
--timestamp-headerstringOptionalHeader that carries the signed timestamp (HmacSignature).
--role-arnstringOptionalARN of the IAM role to assume (required on create) (AwsRole).
--external-idstringOptionalExternal ID the role's trust policy requires (required on create) (AwsRole).
--regionstringOptionalAWS region (AwsRole).
--secret-stdinbooleanOptionalRead the secret from stdin (one trailing newline is dropped).
--secret-envstringOptionalRead the secret from this environment variable, used exactly as set.
--valuestringOptionalNot accepted: pass the secret with --secret-stdin or --secret-env.
--secretstringOptionalNot accepted: pass the secret with --secret-stdin or --secret-env.
--client-secretstringOptionalNot 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