Skip to content

Commit 2624468

Browse files
jkodroffclaude
andcommitted
Break out organization identity providers into its own concepts page
The only documentation of how a Pulumi organization's membership is backed lived at the bottom of the Organizations concepts page, below "Deleting your account," and was never linked from the SAML guides or the version-control integration pages. Adds /docs/administration/concepts/identity-providers/ covering Pulumi, GitHub, GitLab, Bitbucket, and SAML 2.0, with per-provider setup and the prerequisite that members link the new identity before the switch. The Organizations page keeps its heading as a pointer stub so the existing #organization-identity-providers anchor still resolves. Verified against pulumi-service and corrected several claims: the permission is organization:change_backend (admin by default, grantable to a custom role), Bitbucket alone requires workspace admin, only top-level GitLab groups qualify, and "disconnecting" means selecting Pulumi. Fixes #21093 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SfR3RL4KvJeyWjdmAiNfZ5
1 parent 1c280a6 commit 2624468

19 files changed

Lines changed: 189 additions & 102 deletions

File tree

content/blog/p3-some-assembly-required/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Let’s go through each of those and briefly discuss what it looks like to set t
6565

6666
## Authentication and identity management
6767

68-
We highly recommend using GitHub for code management. So much so that we have deeply integrated GitHub into Pulumi Cloud across a number of features. While we support [alternatives such as GitLab](https://www.pulumi.com/docs/pulumi-cloud/organizations/#gitlab-identity-provider), this will be the easiest and more feature-rich way to configure your platform.
68+
We highly recommend using GitHub for code management. So much so that we have deeply integrated GitHub into Pulumi Cloud across a number of features. While we support [alternatives such as GitLab](https://www.pulumi.com/docs/administration/concepts/identity-providers/#gitlab), this will be the easiest and more feature-rich way to configure your platform.
6969

7070
In Pulumi Cloud, you have the ability to create organizations. A [Pulumi Cloud organization](https://www.pulumi.com/docs/pulumi-cloud/organizations/) can help you manage teams, roles, stacks, settings, and provide a dashboard across the entire organization. Pulumi Cloud also allows you to use a variety of identity providers to log in, including GitHub.
7171

content/blog/using-pulumi-securely/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The following recommendations should help you get started and prepare you to sca
4242

4343
### Manage Federated Identity
4444

45-
Connect your user and Pulumi organization with an [Identity Provider](/docs/administration/organizations-teams/organizations/#organization-identity-providers) such as [Github](/docs/administration/organizations-teams/organizations/#github-identity-provider), [Gitlab](/docs/administration/organizations-teams/organizations/#gitlab-identity-provider) or [BitBucket](/docs/administration/organizations-teams/organizations/#bitbucket-identity-provider), your [Single Sign On (SSO)](/docs/administration/organizations-teams/organizations/#saml-single-sign-on-sso) system and/or another [System for Cross-Domain Identity Management](/docs/administration/access-identity/scim/) (SCIM). Your code repositories hold your Infrastructure as Code, and most organizations are motivated to keep access tightly controlled. SSO improves this process across tools and puts more control into your organization’s hands. SCIM enables you to manage your users and groups centrally in your Identity Provider (IdP) and then synchronize those users and groups to the Pulumi Service. Leveraging your existing onboarding and offboarding process will help limit the risk of bad actors in Pulumi itself.
45+
Connect your user and Pulumi organization with an [Identity Provider](/docs/administration/concepts/identity-providers/) such as [Github](/docs/administration/concepts/identity-providers/#github), [Gitlab](/docs/administration/concepts/identity-providers/#gitlab) or [BitBucket](/docs/administration/concepts/identity-providers/#bitbucket), your [Single Sign On (SSO)](/docs/administration/concepts/identity-providers/#saml-20) system and/or another [System for Cross-Domain Identity Management](/docs/administration/access-identity/scim/) (SCIM). Your code repositories hold your Infrastructure as Code, and most organizations are motivated to keep access tightly controlled. SSO improves this process across tools and puts more control into your organization’s hands. SCIM enables you to manage your users and groups centrally in your Identity Provider (IdP) and then synchronize those users and groups to the Pulumi Service. Leveraging your existing onboarding and offboarding process will help limit the risk of bad actors in Pulumi itself.
4646

4747
### Build Pulumi Teams
4848

content/docs/administration/concepts/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ How Pulumi Cloud models your organization and who can do what inside it. Read th
1818
## Organization and identity
1919

2020
- [Organizations](/docs/administration/concepts/organizations/) — the top-level container that owns your stacks, environments, and settings.
21+
- [Identity providers](/docs/administration/concepts/identity-providers/) — the GitHub, GitLab, Bitbucket, or SAML 2.0 provider that governs who can be a member of your organization.
2122
- [Accounts](/docs/administration/concepts/accounts/) — individual user accounts, profiles, and identity providers.
2223
- [Agent accounts](/docs/administration/concepts/agent-accounts/) — accounts for AI agents and automation acting on your organization's behalf.
2324
- [Billing managers](/docs/administration/concepts/billing-managers/) — the role that delegates billing access without granting admin rights.

content/docs/administration/concepts/access-tokens.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menu:
77
administration:
88
name: Access tokens
99
parent: administration-concepts
10-
weight: 5
10+
weight: 6
1111
aliases:
1212
- /docs/administration/access-identity/access-tokens/
1313
- /docs/intro/pulumi-service/organization-access-tokens/

content/docs/administration/concepts/accounts.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ menu:
77
administration:
88
name: Accounts
99
parent: administration-concepts
10-
weight: 2
11-
10+
weight: 3
1211
aliases:
1312
- /docs/administration/organizations-teams/accounts/
1413
- /docs/intro/console/accounts/
@@ -58,15 +57,21 @@ If you signed up using an email address and need to resend the verification emai
5857
3. Under your email address, you will see the option to resend the verification email.
5958
![Resend Verification Email](/images/docs/pulumi-cloud/accounts/resend-verification.png)
6059

61-
### Adding New Identities {#adding-new-identities}
60+
### Adding new identities {#adding-new-identities}
6261

63-
You can associate your Pulumi account with multiple identities. In addition to the one you have originally configured, you can add your identities with the following third-party providers:
62+
You can associate your Pulumi account with multiple identities. Besides the one you originally configured, you can add identities from the following third-party providers:
6463

6564
{{< identities >}}
6665

67-
Connecting these additional identities will enable you to join Pulumi organizations that are backed by those systems. Only organization admins can add members to a Pulumi organization.
66+
To add one:
6867

69-
In order to be invited as a member of a Pulumi organization, you must connect your account with the organization's backing identity provider. Once your account is linked to your third-party identity, you will then show up on the list of users that the organization admin can invite.
68+
1. Click on your account avatar in the top right corner.
69+
1. Select **Account settings**.
70+
1. In the **Identity providers** section, find the provider under **Available identities** and select **Connect**.
71+
72+
Connecting these additional identities lets you join Pulumi organizations that are backed by those systems. Only organization admins can add members to a Pulumi organization.
73+
74+
To be invited as a member of a Pulumi organization, you must connect your account with the organization's backing [identity provider](/docs/administration/concepts/identity-providers/). Once your account is linked to your third-party identity, you show up on the list of users that the organization admin can invite.
7075

7176
## Password Reset
7277

content/docs/administration/concepts/agent-accounts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menu:
77
administration:
88
name: Agent Accounts
99
parent: administration-concepts
10-
weight: 3
10+
weight: 4
1111
aliases:
1212
- /docs/administration/organizations-teams/agent-accounts/
1313
---

content/docs/administration/concepts/audit-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menu:
77
administration:
88
name: Audit Logs
99
parent: administration-concepts
10-
weight: 7
10+
weight: 8
1111
identifier: administration-concepts-audit-logs
1212
aliases:
1313
- /docs/administration/security-compliance/audit-logs/

content/docs/administration/concepts/billing-managers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ menu:
77
administration:
88
name: Billing managers
99
parent: administration-concepts
10-
weight: 4
10+
weight: 5
1111
aliases:
1212
- /docs/pulumi-cloud/access-management/billing-managers/
1313
- /docs/intro/pulumi-service/billing-managers/
@@ -27,7 +27,7 @@ The Team edition is limited to 1 Billing Manager at a time; the Enterprise and B
2727
Billing Manager invitations work much the same way member invitations do, but they are managed on the Billing and Usage page.
2828

2929
{{% notes type="info" %}}
30-
Billing Managers, like members, must be members of the [organization identity provider](/docs/administration/concepts/organizations/#organization-identity-providers) in order to gain access to the Pulumi organization.
30+
Billing Managers, like members, must be members of the [organization identity provider](/docs/administration/concepts/identity-providers/) in order to gain access to the Pulumi organization.
3131
{{% /notes %}}
3232

3333
To invite a new Billing Manager:

content/docs/administration/concepts/customer-managed-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ h1: Customer Managed Keys
66
menu:
77
administration:
88
parent: administration-concepts
9-
weight: 8
9+
weight: 9
1010
identifier: administration-concepts-customer-managed-keys
1111
aliases:
1212
- /docs/pulumi-cloud/customer-managed-keys/
Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
title_tag: "Pulumi Cloud: Organization Identity Providers"
3+
meta_desc: How Pulumi Cloud organizations are backed by GitHub, GitLab, Bitbucket, or a SAML 2.0 identity provider, and how to set up or change the provider.
4+
title: Identity Providers
5+
h1: Pulumi Cloud organization identity providers
6+
menu:
7+
administration:
8+
name: Identity Providers
9+
parent: administration-concepts
10+
weight: 2
11+
identifier: administration-concepts-identity-providers
12+
---
13+
14+
Every Pulumi organization is backed by exactly one identity provider, which governs who is allowed to be a member. New organizations use the Pulumi identity provider, where membership is managed entirely in Pulumi Cloud. You can instead back an organization with a GitHub organization, a GitLab group, a Bitbucket workspace, or a SAML 2.0 identity provider.
15+
16+
When an organization is backed by a third party, membership is the intersection of two things: a user must belong to the Pulumi organization *and* be a current member of the backing organization, group, or workspace. As soon as someone loses access to the backing system, they lose access to the Pulumi organization.
17+
18+
A user who belongs to the backing system but has not been added to the Pulumi organization yet is a *potential member*. Potential members appear on the list of people an organization admin can invite, but they cannot use the organization until they are added.
19+
20+
## Available identity providers
21+
22+
| Identity provider | Membership comes from | Setup |
23+
|---|---|---|
24+
| Pulumi | The Pulumi organization's own member list | The default for new organizations. No third-party configuration required. |
25+
| GitHub | A GitHub organization | [GitHub](#github) |
26+
| GitLab | A top-level GitLab group | [GitLab](#gitlab) |
27+
| Bitbucket | A Bitbucket workspace | [Bitbucket](#bitbucket) |
28+
| SAML 2.0 | The users your identity provider assigns to the Pulumi application | [SAML 2.0](#saml-20) |
29+
30+
These options are mutually exclusive. An organization uses one identity provider at a time, and selecting a new one replaces the old one.
31+
32+
## Before you change identity providers
33+
34+
Changing an organization's identity provider takes effect immediately, and Pulumi does not check in advance whether your existing members can meet the new requirement. Anyone who cannot is locked out until they can.
35+
36+
Before you change providers:
37+
38+
1. Link an identity from the new provider to your own Pulumi account first. You cannot select a provider you have no identity for, and if you lock yourself out you cannot change the setting back.
39+
1. Confirm that every member has linked an identity from the new provider to their Pulumi account, under **Account settings** > **Identity providers**. For the steps, see [Adding new identities](/docs/administration/concepts/accounts/#adding-new-identities).
40+
1. Confirm that every member belongs to the GitHub organization, GitLab group, or Bitbucket workspace you are about to require.
41+
42+
Members who do not meet the new requirement are not deleted. Their membership records remain in place, and they regain access as soon as they link the required identity and belong to the backing organization.
43+
44+
## Permissions
45+
46+
Changing the identity provider requires the `organization:change_backend` permission, shown as **Change organization backend** in Pulumi Cloud. Organization admins have it by default, and you can grant it to a [custom role](/docs/administration/concepts/rbac/roles/). See [Organization settings scopes](/docs/administration/reference/rbac-scopes/org-settings/).
47+
48+
Some providers add a requirement on top of this one. To select a Bitbucket workspace, you must also be an admin of that workspace. See [Bitbucket](#bitbucket).
49+
50+
## Changing your organization's identity provider
51+
52+
1. Navigate to **Settings** > **Access management**.
53+
1. Select the **Other** tab.
54+
1. In the **Membership Requirements** section, select **Change requirements**.
55+
1. On the **Select Requirements** step, choose an identity provider, then choose the specific organization, group, or workspace that should back your Pulumi organization.
56+
1. On the **Confirm Requirements** step, review the change and select **Apply changes**.
57+
58+
The change takes effect immediately and is recorded in your [audit logs](/docs/administration/concepts/audit-logs/). Admins can change the requirement again at any time.
59+
60+
{{% notes type="info" %}}
61+
A given GitHub organization, GitLab group, or Bitbucket workspace can back only one Pulumi organization. If it already backs another one, Pulumi rejects the change with the message "That organization is already registered."
62+
{{% /notes %}}
63+
64+
The **Membership Requirements** section does not appear for individual accounts or for legacy per-stack organizations, because membership works differently for those.
65+
66+
## GitHub
67+
68+
A GitHub-backed organization draws its membership from a [GitHub organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch). Only members of that GitHub organization can belong to the Pulumi organization.
69+
70+
To back your organization with GitHub:
71+
72+
1. Connect a GitHub identity to your Pulumi account under **Account settings** > **Identity providers**.
73+
1. Make sure the Pulumi OAuth app is authorized for the GitHub organization with the [`read:org` scope](https://github.com/settings/connections/applications/7cf9078f3c92b17a5f0f), which Pulumi uses to verify who belongs to the organization. Depending on the GitHub organization's third-party application policy, a GitHub organization owner may need to grant or approve this access. Pulumi does not get access to source code, issues, or any other organization data.
74+
1. [Change your organization's identity provider](#changing-your-organizations-identity-provider) and select the GitHub organization.
75+
76+
If the backing GitHub organization enforces its own SAML SSO, each member must also authorize their GitHub credential for that organization. Until they do, GitHub does not report their membership to Pulumi and they cannot access the Pulumi organization.
77+
78+
## GitLab
79+
80+
A GitLab-backed organization draws its membership from a top-level [GitLab group](https://docs.gitlab.com/user/group/). Subgroups cannot back a Pulumi organization.
81+
82+
To back your organization with GitLab:
83+
84+
1. Connect a GitLab identity to your Pulumi account under **Account settings** > **Identity providers**.
85+
1. Make sure the group is visible to your GitLab account.
86+
1. [Change your organization's identity provider](#changing-your-organizations-identity-provider) and select the GitLab group.
87+
88+
GitLab lets group owners grant memberships that expire. A member whose GitLab group membership has expired, or is in any state other than active, loses access to the Pulumi organization.
89+
90+
## Bitbucket
91+
92+
A Bitbucket-backed organization draws its membership from a [Bitbucket workspace](https://support.atlassian.com/bitbucket-cloud/docs/what-is-a-workspace/). Bitbucket identities are labeled **Atlassian** in your account settings.
93+
94+
{{% notes type="info" %}}
95+
Unlike GitHub and GitLab, Bitbucket requires that whoever makes the change be an admin of the target Bitbucket workspace. Bitbucket's member-listing API behaves differently for admins than for other members, so Pulumi verifies this up front rather than failing later.
96+
{{% /notes %}}
97+
98+
To back your organization with Bitbucket:
99+
100+
1. Connect an Atlassian identity to your Pulumi account under **Account settings** > **Identity providers**, granting the Pulumi OAuth app [read access](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html#OAuthonBitbucketCloud-Scopes) to your account and workspace membership information.
101+
1. Confirm that you are an admin of the workspace.
102+
1. [Change your organization's identity provider](#changing-your-organizations-identity-provider) and select the Bitbucket workspace.
103+
104+
Once the change is complete, admins can see the list of Bitbucket workspace members and add or invite them to the Pulumi organization.
105+
106+
## SAML 2.0
107+
108+
{{< pulumi-cloud "saml-sso" />}}
109+
110+
A SAML-backed organization draws its membership from the users your identity provider assigns to the Pulumi application. Pulumi Cloud works with any SAML 2.0 identity provider, including Microsoft Entra ID, Google Workspace, Okta, OneLogin, Auth0, and JumpCloud.
111+
112+
Configuring SAML is covered by the [SAML SSO guides](/docs/administration/guides/saml/). Two things are specific to switching your organization to SAML:
113+
114+
- **You become the organization owner.** Pulumi makes the user who applies the SAML configuration the organization owner, so that an error in the identity provider metadata cannot lock everyone out of the organization.
115+
- **Your account cannot have other commitments.** You must not belong to unrelated Pulumi organizations, and your individual account must not own any stacks or environments. Transfer or delete them first.
116+
117+
[SCIM provisioning](/docs/administration/guides/scim/) is available only for SAML-backed organizations, and the **SAML & SCIM** settings tab appears only once your organization is SAML-backed. Switching a SAML organization to another identity provider stops SCIM provisioning.
118+
119+
Members of a SAML organization can sign in with the organization name pre-filled by visiting `https://app.pulumi.com/welcome/<organization-name>/sso`.
120+
121+
## Removing a third-party identity provider
122+
123+
You remove a third-party identity provider by selecting a different one — there is no "none" option. To go back to managing membership entirely in Pulumi Cloud, follow [Changing your organization's identity provider](#changing-your-organizations-identity-provider) and select **Pulumi**.
124+
125+
This is also how you remove a SAML SSO configuration.
126+
127+
## Learn more
128+
129+
- [Accounts](/docs/administration/concepts/accounts/) — linking third-party identities to your individual Pulumi account.
130+
- [Organizations](/docs/administration/concepts/organizations/) — creating organizations, inviting members, and organization roles.
131+
- [SAML SSO](/docs/administration/guides/saml/) — configuring Pulumi Cloud with a SAML 2.0 identity provider.
132+
- [SCIM](/docs/administration/guides/scim/) — automating user and team provisioning from your identity provider.
133+
- [Organization settings scopes](/docs/administration/reference/rbac-scopes/org-settings/) — the full list of organization-level RBAC permissions.

0 commit comments

Comments
 (0)