Skip to content

Commit 01e172d

Browse files
committed
chore: add docs for okta scim role support
1 parent 784043b commit 01e172d

File tree

4 files changed

+38
-1
lines changed

4 files changed

+38
-1
lines changed

images/scim/okta/add-attribute.png

199 KB
Loading

images/scim/okta/select-roles.png

21.7 KB
Loading

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

product/enterprise-offering/org-management/scim/okta.mdx

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,43 @@ Whenever you assign a `User` or `Group` to the application, Okta automatically p
5959

6060
---
6161

62+
### Organisation role support
63+
64+
Portkey supports the following organisation roles:
65+
66+
- **`owner`** (Organization Owner)
67+
- **`admin`** (Organization Admin)
68+
- **`member`** (Organization Member)
69+
70+
Users assigned any other role will default to the **member** role.
71+
72+
#### Editing Attributes
73+
74+
Okta by default doesn't support role attributes. To support role attributes, you need to edit the attributes in Okta.
75+
76+
1. Navigate to the app settings. Under general settings, click on the `Provisioning` tab.
77+
78+
2. Click on the `Go to Profile Editor` button, found under **Attribute Mappings** section.
79+
80+
3. Click on the `Add Attribute` button.
81+
82+
4. Fill the form with the following details:
83+
84+
![Edit Attribute List](/images/scim/okta/add-attribute.png)
85+
86+
5. Click on the `Save` button.
87+
88+
#### Verifying the changes
89+
90+
To verify the changes, you can assign a user to the application with the desired role (e.g., **`owner`**, **`member`**, or **`admin`**) for the organization.
91+
92+
![Assigning Roles](/images/scim/okta/select-roles.png)
93+
94+
<Warning>
95+
Make sure to select only **one** role for a user, if multiple selected user will be assigned to highest qualified role.
96+
</Warning>
97+
---
98+
6299
### Group Provisioning with Okta
63100

64101
Portkey supports RBAC (Role-Based Access Control) for workspaces mapped to groups in Okta. Use the following naming convention for groups:

0 commit comments

Comments
 (0)