Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme for increased clarity on client authentication process #9

Merged
7 commits merged into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ available for accessing the required platform APIs.
> [Onboarding the App with JSESSIONID](https://developer.intelligentautomationplatform.ericsson.net/#tutorials/go-sample-app?step=5&chapter=onboarding-the-app-with-jsessionid)
> in the *Build, onboard and instantiate a 'Hello World App' in Go* tutorial.

For *onboarding and instantiating* the Hello World App, the user logged into
the system needs to be assigned all the following permissions:
For *onboarding and instantiating* the Hello World App, the client logged into
the platform needs to be assigned all the following permissions:

| Role | Role Description |
| --------------------------------------------------------------- | ----------------------------------------------------------------------------- |
Expand All @@ -160,9 +160,11 @@ the system needs to be assigned all the following permissions:
| Exposure_Application_Administrator | Access to Service Exposure Onboarding APIs for the Apps. |
| UserAdministration_ExtAppRbac_Application_SecurityAdministrator | Access to Service Exposure Access control APIs for the Apps. |

Use the following command to generate a valid access token:
> **Note:** Contact the platform administrator to request a client with the required roles, as well as the CA certificate required for authentication. They will provide you with a Client ID and Client Secret, along with a CA certificate file.

Refer to [Client Access to REST APIs](#tutorials/client-access) for further details on client authentication.

> Contact your platform administrator for the required CA certificate.
Use the following command to generate a valid access token:

```bash
curl --cacert <PATH_TO_CA_CERTIFICATE> --request POST \
Expand Down
2 changes: 1 addition & 1 deletion version
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can remove version update here, as this will be accounted for in the weekly release

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's the correct version, it only shows up as a change because this branch is behind main.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.1.1
3.1.2
Loading