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

feat(MCSPAuthenticator): add new authenticator for Multi-Cloud Saas Platform #198

Merged
merged 1 commit into from
Nov 15, 2023

Conversation

padamstx
Copy link
Member

@padamstx padamstx commented Nov 6, 2023

This commit introduces the new MCSPAuthenticator that can be used to exchange an apikey for an MCSP access token using the Multi-Cloud Saas Platform authentication token server's 'POST /siusermgr/api/1.0/apikeys/token' operation.

@padamstx padamstx self-assigned this Nov 6, 2023
@padamstx padamstx force-pushed the mcsp-authenticator branch 2 times, most recently from 87fe96a to b226307 Compare November 6, 2023 18:28
@padamstx padamstx marked this pull request as ready for review November 6, 2023 18:29
Copy link
Member

@dpopp07 dpopp07 left a comment

Choose a reason for hiding this comment

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

Looks good! Found some potential typos to consider but no feedback on the implementation from my side

Authentication.md Outdated Show resolved Hide resolved
core/mcsp_authenticator.go Outdated Show resolved Hide resolved
core/mcsp_authenticator.go Outdated Show resolved Hide resolved
core/mcsp_authenticator.go Outdated Show resolved Hide resolved
@padamstx padamstx force-pushed the mcsp-authenticator branch 2 times, most recently from 54a0c24 to b4cc9a7 Compare November 7, 2023 19:53
### Usage Notes
- When constructing an MCSPAuthenticator instance, you must specify the ApiKey and URL properties.

- The authenticator will use the token server's `POST /siusermgr/api/1.0/apikeys/token` operation to
Copy link
Member

Choose a reason for hiding this comment

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

The readme looks good to me, although I am curious as to what this /siusermgr/api/1.0/apikeys/token endpoint is. Is this something users will need to be worried about or could potentially want to change?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, that's just the "path" associated with the operation that the authenticator invokes. I just added that statement so that curious users (and developers) would know which specific operation the authenticator is using to do the token exchange.

@padamstx padamstx force-pushed the mcsp-authenticator branch 4 times, most recently from 86d05af to 35a1cde Compare November 10, 2023 17:59
…latform

This commit introduces the new MCSPAuthenticator that can be used
to exchange an apikey for an MCSP access token using the Multi-Cloud Saas Platform
authentication token server's 'POST /siusermgr/api/1.0/apikeys/token' operation.

Signed-off-by: Phil Adams <[email protected]>
Copy link
Member

@dpopp07 dpopp07 left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

@padamstx padamstx merged commit 8987085 into main Nov 15, 2023
4 checks passed
@padamstx padamstx deleted the mcsp-authenticator branch November 15, 2023 18:31
ibm-devx-sdk pushed a commit that referenced this pull request Nov 15, 2023
# [5.15.0](v5.14.1...v5.15.0) (2023-11-15)

### Features

* **MCSPAuthenticator:** add new authenticator for Multi-Cloud Saas Platform ([#198](#198)) ([8987085](8987085))
@ibm-devx-sdk
Copy link

🎉 This PR is included in version 5.15.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants