Skip to content

Commit 468eafc

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 4877e00 commit 468eafc

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Command Issuer is installed using a Helm chart. The chart is available in the [C
128128
```
129129

130130
Optionally, set the Docker image tag of command-cert-manager-issuer to deploy ([available tags](https://hub.docker.com/r/keyfactor/command-cert-manager-issuer/tags))
131-
131+
132132
```shell
133133
helm install command-cert-manager-issuer command-issuer/command-cert-manager-issuer \
134134
--namespace command-issuer-system \
@@ -263,7 +263,7 @@ For example, ClusterIssuer resources can be used to issue certificates for resou
263263
# certificateAuthorityHostname: "$COMMAND_CA_HOSTNAME" # Uncomment if required
264264
certificateAuthorityLogicalName: "$COMMAND_CA_LOGICAL_NAME"
265265
certificateTemplate: "$CERTIFICATE_TEMPLATE_SHORT_NAME"
266-
# scopes: "openid email https://example.com/.default" # Uncomment if desired
266+
# scopes: "openid email https://example.com/.default" # Uncomment if required
267267
# audience: "https://your-command-url.com" # Uncomment if desired
268268
EOF
269269
@@ -289,7 +289,7 @@ For example, ClusterIssuer resources can be used to issue certificates for resou
289289
# certificateAuthorityHostname: "$COMMAND_CA_HOSTNAME" # Uncomment if required
290290
certificateAuthorityLogicalName: "$COMMAND_CA_LOGICAL_NAME"
291291
certificateTemplate: "$CERTIFICATE_TEMPLATE_SHORT_NAME"
292-
# scopes: "openid email https://example.com/.default" # Uncomment if desired
292+
# scopes: "openid email https://example.com/.default" # Uncomment if required
293293
# audience: "https://your-command-url.com" # Uncomment if desired
294294
EOF
295295
@@ -414,6 +414,30 @@ Keyfactor Command allows users to [attach custom metadata to certificates](https
414414
metadata.command-issuer.keyfactor.com/<metadata-field-name>: <metadata-value>
415415
```
416416

417+
# Troubleshooting
418+
419+
## Failed to Authenticate, Received Status Code 401 from Keyfactor Command
420+
421+
If you see this error, the identity provider that issued credentials to your command-cert-manager-issuer (using OAuth, Basic, or ambient credentials) is not a registered identity provider in your Keyfactor Command instance. Please see the [Configuring Command](#configuring-command) section for more information.
422+
423+
```bash
424+
failed to create new Command API client: failed to authenticate, received status code 401 from Keyfactor Command
425+
```
426+
427+
## Failed to Authenticate, Received Status Code 403 from Keyfactor Command
428+
429+
If you see this error, the identity provider that issued credentials to your command-cert-manager-issuer (using OAuth, Basic, or ambient credentials) is configured in Keyfactor Command, however the identity associated to those credentials is not associated with any security roles. Make sure the identity is mapped to a security claim. See the **Configure Command Security Roles and Claims** section of the [Configuring Command](#configuring-command) section for more information.
430+
431+
```bash
432+
failed to create new Command API client: failed to authenticate, received status code 403 from Keyfactor Command: {\"ErrorCode\":\"0xA0140002\",\"Message\":\"User <user-id> doesn\\u0027t have the required permission\"}
433+
```
434+
435+
If you see this sort of error, the identity is mapped to one or more security roles in Keyfactor Command, but is missing the necessary permissions. See the **Configure Command Security Roles and Claims** section of the [Configuring Command](#configuring-command) section for the required permissions.
436+
437+
```bash
438+
failed to fetch metadata fields from connected Command instance: User <user-id> does not have the required permissions: /metadata/types/read/.
439+
```
440+
417441

418442

419443
## License

0 commit comments

Comments
 (0)