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 3 commits
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
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,19 +139,23 @@ ls ./csar-output

## Onboard the App

### Prerequisites for Onboarding

The client with the required roles is authenticated and an access token is
available for accessing the required platform APIs.

> Authenticating a user with JSession ID is deprecated, and will be removed
> in EIC 1.2438. If you still need to authenticate with a JSession ID,
> please follow:
> [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:
### Prerequisites for Onboarding

Contact the platform administrator to request the following:

- A CA certificate
- This is needed for secure communication with the platform APIs.
- Client Access to the platform with the required roles.
- This is needed for authorized communication with the platform APIs used to to
*onboard and instantiate* the Hello World App.
- You will receive a Client ID and Client Secret from the platform administrator.
- Include the required roles listed below in the request.

| Role | Role Description |
| --------------------------------------------------------------- | ----------------------------------------------------------------------------- |
Expand All @@ -160,9 +164,10 @@ 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:
Refer to [Client Access to REST APIs](https://developer.intelligentautomationplatform.ericsson.net/#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.3