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

CIAMP-1237: documentation for SSO #9007

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

CIAMP-1237: documentation for SSO #9007

wants to merge 8 commits into from

Conversation

emilywoods
Copy link
Contributor

@emilywoods emilywoods commented Oct 8, 2024

Description

Ticket: https://circleci.atlassian.net/browse/CIAMP-1237

Contains the following sections:

  • Introduction to SSO (with CircleCI)
  • How to set up SSO
  • How to join/login to an SSO org as a user

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸:

  • reviewed by member of my team
  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume - thoughts on whether it would benefit from screenshots?
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.

@emilywoods emilywoods changed the title CIAMP-1237: documentation CIAMP-1237: documentation for SSO Oct 9, 2024
@emilywoods emilywoods marked this pull request as ready for review October 9, 2024 14:52
@emilywoods emilywoods requested review from a team as code owners October 9, 2024 14:52
Contains the following sections:
- Introduction to SSO (with CircleCI)
- How to set up SSO
- How to join/login to an SSO org as a user

=== Configure your Identity Provider (IdP)

. Open your IdP and paste the required configuration details retrieved from CircleCI in the previous section
Copy link
Contributor

Choose a reason for hiding this comment

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

For this section it would be great to point ot a few third-party docs pages that show this setup, I wasn't 100% sure from looking at the Okta docs for example. Could you suggest some?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

[join-an-organization]
=== Join an organization

New users can join an organization via link:https://circleci.com/docs/manage-roles-and-permissions/#add-people-to-your-organization[an invite] or by visiting https://circleci.com/authentication/login?f=sso. In the future, a `Join with SSO` button will be added to the user homepage.
Copy link
Contributor

@rosieyohannan rosieyohannan Oct 14, 2024

Choose a reason for hiding this comment

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

I think the intended audience for this page is users wanting to access a SSO-enabled CCI org, so an alternative to the flows documented here: https://circleci.com/docs/invite-your-team/ ... Just checking this and then I will change the voice in this content to address the user directly and add a link to this page from the invite-your-team doc

:icons: font
:experimental:

NOTE: SAML single sign-on for CircleCI is currently in closed preview.
Copy link
Contributor

@labsquared labsquared Oct 15, 2024

Choose a reason for hiding this comment

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

Specify that preview is for Scale plan customers. Link to #prerequisites-and-limitations header for details.
Submit feedback to https://circleci.canny.io/identities-permissions/p/single-sign-on-sso.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Have addressed this here: 154e5cf

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

Successfully merging this pull request may close these issues.

4 participants