Skip to content

Atru/hcp ibmid login ipe 1573 - #3478

Open
trujillo-adam wants to merge 13 commits into
mainfrom
atru/hcp-ibmid-login-ipe-1573
Open

trujillo-adam wants to merge 13 commits into
mainfrom
atru/hcp-ibmid-login-ipe-1573

Conversation

@trujillo-adam

Copy link
Copy Markdown
Contributor

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.

@trujillo-adam
trujillo-adam marked this pull request as ready for review September 19, 2026 00:16
@trujillo-adam
trujillo-adam requested review from a team as code owners September 19, 2026 00:16
@github-actions

github-actions Bot commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Tue Oct 20 21:47:15 UTC 2026
Unified Docs API ✅ Ready (Inspect) Visit Preview Tue Oct 20 21:44:06 UTC 2026

@github-actions

github-actions Bot commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Broken Link Checker

This PR contains broken links, but won't be blocked. Use this report to improve content quality:

Quick Actions

  • Internal links (HashiCorp sites): Please fix these - they impact user experience
  • External links: Consider if these are essential or can be updated/removed
  • Temporary issues: External sites may recover - check again before merging

Need Help?


Internal Links

Full Github Actions output

External Links

Summary

Status Count
🔍 Total 49
✅ Successful 12
⏳ Timeouts 0
🔀 Redirected 7
👻 Excluded 27
❓ Unknown 0
🚫 Errors 3
⛔ Unsupported 0

Errors per input

Errors 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 input

Redirects 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

Full Github Actions output

robin-norwood
robin-norwood previously approved these changes Sep 21, 2026

@robin-norwood robin-norwood left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm with some suggestions.

Comment thread content/hcp-docs/content/docs/hcp/iam/sso/setup/saml.mdx Outdated
Comment thread content/hcp-docs/content/docs/hcp/iam/mfa.mdx Outdated
Comment thread content/hcp-docs/content/docs/hcp/iam/mfa.mdx Outdated
Comment thread content/hcp-docs/content/docs/hcp/iam/mfa.mdx Outdated
Comment thread content/hcp-docs/content/docs/hcp/create-account.mdx Outdated
Comment thread content/hcp-docs/content/docs/hcp/create-account.mdx Outdated
Comment thread content/hcp-docs/content/docs/hcp/create-account.mdx Outdated
Comment thread content/hcp-docs/content/docs/hcp/create-account.mdx

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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>
Comment thread content/hcp-docs/content/docs/hcp/create-account.mdx Outdated
Comment thread content/hcp-docs/content/docs/hcp/create-account.mdx Outdated
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
mattschouten
mattschouten previously approved these changes Oct 12, 2026

@mattschouten mattschouten left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I did see an earlier comment about Discuss - not sure if that's relevant here.

![QR Error Code](/img/docs/qr-code-error.png 'QR Error code')

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
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)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [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:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 branch was successfully deployed

1 active (outdated) deployment
Preview — 39c1f1b4 Deployed Sep 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants