Merge pull request #103 from reubenmiller/chore-backport-c8y-getting-…

…started-required-role docs: backport c8y required roles note in the getting started guide
thin-edge · Feb 4, 2025 · ebf2ff7 · ebf2ff7
2 parents d732152 + 9f18af7
commit ebf2ff7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/versioned_docs/version-1.4.2/.version b/versioned_docs/version-1.4.2/.version
@@ -1 +1 @@
-1.4.2-82-gce649ba125 main
+1.4.2-85-g17b838b8dc main
diff --git a/versioned_docs/version-1.4.2/start/connect-c8y.md b/versioned_docs/version-1.4.2/start/connect-c8y.md
@@ -190,7 +190,7 @@ sudo tedge cert upload c8y --user "$C8Y_USER"
 
 Below shows some common errors that can be experienced when trying to upload the device certificate.
 
-#### InvalidCertificate(NotValidForName)
+#### InvalidCertificate(NotValidForName) {#common-errors-invalid-certificate}
 
 If you receive the following error, then you are most likely using the [custom domain feature](https://cumulocity.com/docs/enterprise-tenant/customization/#domain-name), and should see the [custom domain instructions](#custom-domain) to configure the correct HTTP and MQTT endpoints.
 
@@ -202,7 +202,7 @@ Caused by:
     Connection check failed
 ```
 
-#### 401 - Unauthorized
+#### 401 - Unauthorized {#common-errors-401}
 
 The 401 (Unauthorized) error means either the user and/or password is invalid for the configured Cumulocity url that was set in the `tedge config set c8y.url <url>` command.
 
@@ -214,7 +214,7 @@ Check the following items to help you diagnose the root cause of the problem:
 * Check that you are not using a SSO user. SSO users are not permitted to use the REST API calls which the `tedge cert upload c8y` command is using. Please create a new Cumulocity user via the [Administration Page](https://cumulocity.com/docs/standard-tenant/managing-users/#to-add-a-user)
 
 
-#### 403 - Forbidden
+#### 403 - Forbidden {#common-errors-403}
 
 The 403 (Forbidden) error means that your user/password is correct however you do not have sufficient permissions to add the %%te%%'s device certificate to the Cumulocity's [Trusted certificates](https://cumulocity.com/docs/device-integration/device-certificates/).
 
@@ -227,7 +227,7 @@ Alternatively, you can explicitly add one of the following permissions to your C
 If you are still having trouble, please check out the official [Cumulocity documentation](https://cumulocity.com/docs/device-integration/device-certificates/#upload-your-ca-certificate).
 
 
-#### Address is unreachable
+#### Address is unreachable {#common-errors-unreachable}
 
 If you are unable to reach Cumulocity, then it is likely that your device's network is not properly configured. This could be for many different reasons, however the following checks might help you spot where the mistake is:
 

diff --git a/versioned_docs/version-1.4.2/start/getting-started.md b/versioned_docs/version-1.4.2/start/getting-started.md
@@ -146,6 +146,8 @@ sudo tedge cert create --device-id "$DEVICE_ID"
 
 The device id is a unique identifier e.g. the MAC address that identifies the physical device.
 
+Before you can upload the device's certificate to Cumulocity, your Cumulocity user must have the **Tenant Manager** Global Role assigned to it. For details on how to do this, see the [docs](connect-c8y.md#common-errors-403).
+
 The certificate is uploaded to the Cumulocity Tenant via:
 
 <UserContext>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		1.4.2-82-gce649ba125 main
		1.4.2-85-g17b838b8dc main