Repository navigation
Atru/hcp ibmid login ipe 1573 - #3478
trujillo-adam wants to merge 13 commits into
Conversation
Vercel Previews Deployed
|
Broken Link CheckerThis PR contains broken links, but won't be blocked. Use this report to improve content quality: Quick Actions
Need Help?
Internal LinksExternal LinksSummary
Errors per inputErrors in content/hcp-docs/content/docs/hcp/create-account.mdx
Errors in content/hcp-docs/content/docs/hcp/iam/mfa.mdx
Errors in content/hcp-docs/content/docs/hcp/iam/sso/setup/saml.mdx
Redirects per inputRedirects in content/hcp-docs/content/docs/hcp/create-account.mdx
Redirects in content/hcp-docs/content/docs/hcp/iam/mfa.mdx
Redirects in content/hcp-docs/content/docs/hcp/iam/sso/setup/saml.mdx
|
robin-norwood
left a comment
There was a problem hiding this comment.
lgtm with some suggestions.
|
|
||
| At the HCP login screen, click the **GitHub** sign-in option. HCP automatically recognizes the matching email and adds GitHub as a sign-in method for your existing account. Your organization memberships, roles, and resource access are unchanged. | ||
|
|
||
| ### Sign in with a different email address |
There was a problem hiding this comment.
This heading matches the one above on line 73. I think the default for anchor links is to go to the first heading, but we should probably avoid this anyway.
There was a problem hiding this comment.
Good callout, but I think we're OK in this case because we are only, and should only, be linking to the parallel topic in the IBMid section.
Co-authored-by: Robin Norwood <robin.norwood@gmail.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
mattschouten
left a comment
There was a problem hiding this comment.
A few suggested changes, and a rendering issue on saml.mdx. Approving so you can merge if needed though.
| ## Enable SAML SSO for HCP | ||
|
|
||
| After your domain is verified, you can set up SAML SSO. | ||
| <!-- TODO: Uncomment when SAML changes are ready to publish: |
There was a problem hiding this comment.
Noting TODOs in this file, just in case.
| | Email and password | MFA is managed in HCP. | Refer to [Enable MFA](#enable-mfa). | | ||
|
|
||
| With MFA, you will need a password (credential), and an authenticator application downloaded to your phone. HCP offers one method of MFA called **one-time password (OTP)**. An OTP is a sequence of numbers that are generated by an authenticator application. If you lose your device, you can use the recovery code provided during the setup process. Make sure to record the recovery code and save it to a secure location. | ||
| Changes to MFA affect your access to HashiCorp Developer, Discuss, Events, and the Certification Portal, because the same account is used to access those sites. |
There was a problem hiding this comment.
I did see an earlier comment about Discuss - not sure if that's relevant here.
|  | ||
|
|
||
| To mitigate this issue, try re-generating a new OTP. If you misplaced your device or unable to access your device, or need to sign in without one, use the recovery code that you securely saved to sign back into [the HCP Portal](https://portal.cloud.hashicorp.com/). Note that there may be a five-minute time-out period if you did not complete the setup process within the timeframe given to complete the MFA setup process. | ||
| Try generating a new OTP. If you cannot access your device, use the recovery code you saved during setup to sign in. The setup process times out after five minutes; if the timeout expires, restart the setup. |
There was a problem hiding this comment.
Should a new paragraph start at "If"? It's not clear to me if "If" starts a new problem to troubleshoot, or if it's a continuation of code verification.
| For more information, refer to [HCP Europe](/hcp/docs/hcp/europe). | ||
| <Warning> | ||
|
|
||
| Email and password sign-in is deprecated and will be removed from HCP on 31 January 2027. Before that date, add IBMid or GitHub as a sign-in method for your account. |
There was a problem hiding this comment.
When the above Warning is uncommented, this paragraph can be removed, right?
| ## Account Settings | ||
| ## Requirements | ||
|
|
||
| Only users who signed up for HCP with their email and password or with GitHub can [remove their accounts](#remove-your-account) in the HCP UI. SSO users, including SCIM-provisioned users, cannot remove their own accounts from the portal. If you authenticate using SSO, contact your organization administrator so that they can de-provision your account through your identity provider. |
There was a problem hiding this comment.
| Only users who signed up for HCP with their email and password or with GitHub can [remove their accounts](#remove-your-account) in the HCP UI. SSO users, including SCIM-provisioned users, cannot remove their own accounts from the portal. If you authenticate using SSO, contact your organization administrator so that they can de-provision your account through your identity provider. | |
| Only users who signed up for HCP with their email and password or with GitHub can [remove their accounts](#remove-your-account) in the HCP UI. SSO users, including SCIM-provisioned users, cannot remove their own accounts using the portal. If you authenticate using SSO, contact your organization administrator so that they can de-provision your account through your identity provider. |
|
|
||
| Only users who signed up for HCP with their email and password or with GitHub can [remove their accounts](#remove-your-account) in the HCP UI. SSO users, including SCIM-provisioned users, cannot remove their own accounts from the portal. If you authenticate using SSO, contact your organization administrator so that they can de-provision your account through your identity provider. | ||
|
|
||
| If your organization uses SSO, HashiCorp recommends maintaining at least two non-SSO users with administrative access. If all non-SSO administrative users are removed and SSO is later disabled, no local user may have sufficient permissions to administer the organization. Refer to [Single sign-on (SSO) overview](/hcp/docs/hcp/iam/sso) for more information. |
There was a problem hiding this comment.
| If your organization uses SSO, HashiCorp recommends maintaining at least two non-SSO users with administrative access. If all non-SSO administrative users are removed and SSO is later disabled, no local user may have sufficient permissions to administer the organization. Refer to [Single sign-on (SSO) overview](/hcp/docs/hcp/iam/sso) for more information. | |
| If your organization uses SSO, HashiCorp recommends maintaining at least two non-SSO users with administrative access. If all non-SSO administrative users are removed and SSO is later disabled, no local user will have sufficient permissions to administer the organization. Refer to [Single sign-on (SSO) overview](/hcp/docs/hcp/iam/sso) for more information. |
| <Warning> | ||
| If your organization uses SSO, HashiCorp recommends maintaining at least one non-SSO user with administrative access. If all non-SSO administrative users are removed and SSO is later disabled, no local user may have sufficient permissions to administer the organization. | ||
| </Warning> | ||
| Before removing your account, HCP performs an automated pre-flight check and blocks removal if you are the owner of one or more HCP organizations. You must resolve all ownership dependencies before your account can be removed. |
There was a problem hiding this comment.
| Before removing your account, HCP performs an automated pre-flight check and blocks removal if you are the owner of one or more HCP organizations. You must resolve all ownership dependencies before your account can be removed. | |
| Before removing your account, HCP performs an automated check and blocks removal if you are the owner of one or more HCP organizations. You must resolve all ownership dependencies before your account can be removed. |
|
|
||
| - [Multi-factor authentication](/hcp/docs/hcp/iam/mfa) | ||
| - [Single sign-on (SSO) overview](/hcp/docs/hcp/iam/sso) | ||
| - [Invite users to an organization](/hcp/docs/hcp/admin/users#invite-users) |
There was a problem hiding this comment.
| - [Invite users to an organization](/hcp/docs/hcp/admin/users#invite-users) | |
| - [Invite users to an organization](/hcp/docs/hcp/iam/users#invite-users) |
| ## Enable SAML SSO for HCP | ||
|
|
||
| After your domain is verified, you can set up SAML SSO. | ||
| <!-- TODO: Uncomment when SAML changes are ready to publish: |
There was a problem hiding this comment.
This file doesn't render in the Vercel preview. When I try locally, it throws an error that seems to point to one of the <!-- TODO comments.
If it all renders okay for you, no big deal. Otherwise there may be something goofy going on with the TODOs.
This PR updates the HCP docs to include information about logging in with IBMid and GitHub. It also fixes several style guide violations, but a comprehensive style guide review is out of scope.