Skip to content

Commit 1cbef32

Browse files
Add section for configuring scim for roles (#6025)
This section details how to set up org role provisioning for Okta
1 parent 8b90ecd commit 1cbef32

7 files changed

+75
-2
lines changed
Loading
Loading
Loading
Loading

src/docs/product/accounts/sso/okta-sso/okta-scim.mdx

+75-2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ If you change your organization slug, you'll need to make the same update in the
2222
- Deactivate users
2323
- Push groups
2424
- Import groups
25+
- Configure organization-level roles
2526

2627
### Requirements
2728

@@ -58,14 +59,86 @@ Okta SCIM provisioning requires:
5859
![Okta Save SCIM Settings](scim-okta-edit.png)
5960

6061
1. Enable both "Create Users" and "Deactivate Users", then "Save" your changes.
62+
![Okta Create and Deactivate Users](okta-user-sync.png)
6163

6264
As a result of these changes, users who are assigned will be sent an invitation email. When a user is un-assigned, their membership object in Sentry will be deleted.
6365

6466
You can use "Push Groups" to sync and assign groups in Okta; they will be reflected in Sentry teams.
6567

66-
### Known Issues / Troubleshooting
68+
### Configuring organization-level roles (Beta)
69+
70+
<Alert level="warning">
71+
72+
Organization role provisioning is in beta. If you'd like to try this feature, contact [email protected].
73+
74+
</Alert>
75+
76+
Here's how to assign an organization-level role to an Okta group:
77+
78+
1. Add a new custom attribute to your Okta application profile.
79+
80+
a. Navigate to your application settings in Okta
81+
82+
b. Under the "Provisioning" tab, select "Go to Profile Editor"
83+
![Okta Provisioning Page](okta-go-to-profile.png)
84+
85+
c. Select "+ Add Attribute"
86+
![Okta Add Attribute](okta-add-attribute.png)
87+
88+
d. Fill out the form with the following settings (you can set whatever value you want for any setting not listed below):
89+
90+
* Data Type: `string`
91+
* Display Name: `Org Role`
92+
* Variable Name: `sentryOrgRole`
93+
* External name: `sentryOrgRole`
94+
* External namespace: `urn:ietf:params:scim:schemas:core:2.0:User`
95+
* Attribute type: `Group`
96+
![Okta Custom Attribute](./okta-custom-attribute-values.png)
97+
98+
99+
2. Assign a group to your okta application
100+
![Okta Assign Group](okta-assign-group.png)
101+
102+
3. In the form, enter the string for the org-level role
103+
![Okta Set Role](okta-set-group-attribute.png)
104+
105+
- If the `sentryOrgField` field is left blank, Group members will be provisioned with the default organization-level role. This default role is configured in Sentry, under Settings -> Organization -> Auth. Otherwise, the role must be one of the following:
106+
- Admin
107+
- Manager
108+
- Billing
109+
- Member
110+
- Invalid role names will prevent group members from being provisioned. To try again, you'll need to remove the group first.
111+
- For security, The "Owner" role cannot be provisioned through SCIM.
112+
- For self-hosted users with custom roles, this extends to any role with the `org:admin` permission
113+
114+
<Alert level="note">
115+
116+
If a user is a member of multiple Okta groups, only the attributes set by the first group will be used.
117+
118+
</Alert>
119+
120+
### Troubleshooting
121+
122+
#### I get an error in Okta when provisioning a user saying "Matching user not found"
123+
124+
Make sure that `Create User` and `Deactivate User` are enabled in the "Provisioning" tab of your Sentry application in Okta
125+
126+
#### I pushed a group to Sentry but the team is empty. (Or) I assigned Sentry to a group but no team was created?
127+
128+
In Okta, there's a difference between pushing and assigning.
129+
130+
Assigning Sentry to a group is the same as assigning Sentry to every member of that group. Functionally, this
131+
provisions every group member within Sentry.
132+
133+
Pushing a group, on the other hand, only tells Sentry to create a new team with the same name as the Okta group. Group
134+
members will be added to the Sentry team only if the user is already provisioned.
135+
136+
In order to sync a group in Okta as a team in Sentry:
137+
1. Assign Sentry to the Group and allow the users to be provisioned
138+
2. Push the Group to Sentry
139+
140+
### Known Issues
67141

68-
- Sentry does not currently support setting any User attributes other than `userName` and `active`.
69142
- The Import Users feature is not currently supported. Sentry's SCIM API does not at this time support the User `name` attribute fields `firstName` and `lastName`. Instead, we return these with values of `N/A` for compatibility purposes.
70143
- Setting `active` to `false` on a User will delete the organization member record associated with the user.
71144
- The only filter operation supported for resources is `eq`.
Loading
Loading

0 commit comments

Comments
 (0)