mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-28 18:12:16 +00:00
d8ea041c56
## Todos for release - [x] Configure Env in docs project on vercel - [x] Configure Root Path in the docs project on vercel - [ ] Remove old CSP https://github.com/zitadel/website/pull/1592 ## What we did This pull request migrates the project documentation from the old `docs/` directory to the new `apps/docs/` directory, introduces a new documentation system built with Next.js and Fumadocs, and updates all relevant references, configuration files, and documentation to reflect this change. It also adds new configuration and ignore files for the new documentation app, updates CI and linting to exclude the new docs from certain checks, and revises the contributing guidelines accordingly. **Documentation System Migration and New Docs App** * Migrated all documentation from `docs/` to `apps/docs/`, and updated all references in `README.md`, `CONTRIBUTING.md`, and other files to point to the new location. [[1]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L585-L640) [[2]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L660-R607) [[3]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L740-R687) [[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L2-R3) [[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L30-R30) * Added a new Next.js/Fumadocs-based documentation app under `apps/docs/`, including core app files, layouts, routing, search API, and a comprehensive `README.md` with development and contribution instructions. [[1]](diffhunk://#diff-5a1b07344a2c1b4d3f37b23ff1388b62cd9f57dea3c1cd23d8a0412b7602b132R1-R74) [[2]](diffhunk://#diff-462b9ad1eabbb7d1c29bb9c36e4931eb180fd7190900e6d2babf8f4d66ad1c28R1-R39) [[3]](diffhunk://#diff-e16ae25660ded787b10ac35dea96d5ecaacf895dae0afc8a9bd4382dc79a8c87R1-R7) [apps/docs/app/[[...slug]]/layout.tsxR1-R81](diffhunk://#diff-59e08acde4e805b7aeccef1dcf98f1d71dfc550777e6b9402085cee0e9fa4e0aR1-R81), [apps/docs/app/[[...slug]]/page.tsxR1-R79](diffhunk://#diff-e5df3f80d0fa01e12d63d81f29c57a9d14e846c78fd3beabb2ef768e38fd9580R1-R79), [[4]](diffhunk://#diff-389b34918e040cacaa87cd7201ffa462cc2b0b716736f537e3d3c660ac69353bR1-R7) [[5]](diffhunk://#diff-d3b03416d1c457b19f1c27b26f2db741412df841b875c26ccadc36e4522247f4R1-R29) [[6]](diffhunk://#diff-c8fb8339570a5305809be7c618e14705fd86390dc278e6ce8ba224a7bc8b0c3cR1-R25) **Configuration and Tooling Updates** * Updated `.github/workflows/codeql.yml`, `.golangci.yaml`, and `.github/dependabot.yml` to properly handle the new docs app: excluded `apps/docs` from certain checks, added npm dependency updates for the docs app, and excluded generated content. [[1]](diffhunk://#diff-12783128521e452af0cfac94b99b8d250413c516ec71fe6d97dbea666ff7ba27L8-R14) [[2]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R5-R6) [[3]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R126-R129) [[4]](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R89-R106) * Updated `.devcontainer/devcontainer.json` to use the latest Go 1.25.3 version for consistency. **Licensing and Miscellaneous** * Added `apps/docs/` to the list of licensed directories in `LICENSING.md`. These changes ensure the documentation is now maintained in a modern, scalable system and all project tooling is updated to support the new structure. --------- Co-authored-by: Federico Coppede <[email protected]>
120 lines
4.3 KiB
Plaintext
120 lines
4.3 KiB
Plaintext
---
|
|
title: SCIM Provisioning from Okta
|
|
---
|
|
|
|
This guide provides step-by-step instructions to configure SCIM provisioning from Okta into ZITADEL.
|
|
|
|
## Pre-requisites:
|
|
|
|
* Access to your ZITADEL Organization with an **Org Owner** role.
|
|
|
|
* Access to your Okta Admin dashboard.
|
|
|
|
* An existing **SAML app integration** between Okta (Identity Provider) and ZITADEL (Service Provider).
|
|
|
|
## Step 1: Set Up SCIM Provisioning in ZITADEL
|
|
|
|
SCIM provisioning in ZITADEL is accomplished by authenticating a Service User with appropriate permissions.
|
|
|
|
1. **Create a Service User**:
|
|
|
|
* Follow [this guide](https://zitadel.com/docs/guides/manage/console/users-overview) to create a Service User within your ZITADEL Organization.
|
|
|
|
2. **Assign the Role**:
|
|
|
|
* Grant the Service User the **Org User Manager** role. No higher managerial role is required.
|
|
|
|
3. **Choose an Authentication Method**:
|
|
|
|
* Select one of these two supported authentication methods:
|
|
|
|
* Personal Access Token \- PAT
|
|
|
|
* Client Credentials Grant
|
|
|
|
4. Detailed instructions to authenticate the Service User can be found [here](https://zitadel.com/docs/guides/integrate/service-users/authenticate-service-users).
|
|
|
|
## Step 2: Set Up SCIM in Okta
|
|
|
|
Follow these precise steps to configure SCIM provisioning in Okta:
|
|
|
|
1. Log in to your Okta Admin Console.
|
|
|
|
2. Navigate to **Applications** → **Application** and the existing **SAML app** linked to ZITADEL.
|
|
|
|
3. Select the **General** tab, then choose **Edit** for **App Settings**.
|
|
|
|
4. In the **Provisioning** section, select **SCIM** and then **Save**.
|
|
|
|
<img src="/docs/img/manage/users/enable-scim-provisioning.png" alt="Enable SCIM provisioning in Okta"/>
|
|
|
|
5. Under the **General** tab, also confirm that [Federation Broker Mode](https://help.okta.com/en-us/content/topics/apps/apps-fbm-main.htm) is disabled.
|
|
|
|
6. Click on the **Provisioning** tab, then go to the **Integration** tab and select **Edit**.
|
|
|
|
<img src="/docs/img/manage/users/select-provisioning-actions.png" alt="Select provisioning actions in Okta"/>
|
|
|
|
7. Enter the **SCIM connector base URL** using this format:
|
|
|
|
```https://${ZITADEL_DOMAIN}/scim/v2/{orgId}```
|
|
Like the example in the above image:
|
|
```https://test-domain-bkeog4.us1.zitadel.cloud/scim/v2/322355063156684166```
|
|
|
|
*(Find more details about endpoints [here](https://zitadel.com/docs/apis/scim2#supported-endpoints)).*
|
|
|
|
8. For **Unique identifier field for users**, enter **userName**.
|
|
|
|
9. Under **Supported provisioning actions**, select ***Push New Users*** and ***Push Profile Updates***.
|
|
|
|
10. Choose your authentication method under **Authentication Mode**:
|
|
|
|
* **HTTP Header** if using a Personal Access Token (PAT).
|
|
|
|
* **OAuth 2** if using Client Credentials Grant.
|
|
|
|
11. Provide the authentication details according to your chosen method:
|
|
|
|
* For **HTTP Header (PAT)**, enter the PAT token generated from ZITADEL.
|
|
|
|
* For **OAuth 2**, provide the client credentials (Client ID, Client Secret, token URL, authorization URL).
|
|
|
|
12. Click **Test Connection Configuration** to verify the integration (optional but recommended), then click **Save**.
|
|
|
|
13. Under the **Provisioning to App** settings, enable:
|
|
|
|
* **Create Users**
|
|
|
|
* **Update User Attributes**
|
|
|
|
* **Deactivate Users**
|
|
|
|
14. Click **Save** to apply these settings.
|
|
|
|
<img src="/docs/img/manage/users/provisioning-to-app.png" alt="Enable provisioning to App in Okta"/>
|
|
|
|
## Step 3: Attribute Mapping (Recommended)
|
|
|
|
Review and adjust attribute mappings in Okta as needed:
|
|
|
|
* Ensure standard attributes such as `userName`, `email`, `name.givenName`, and `name.familyName` are correctly mapped.
|
|
|
|
## Step 4: Verify SCIM Provisioning
|
|
|
|
* Assign the configured application to test users/groups in Okta.
|
|
|
|
* Verify that users are automatically provisioned into ZITADEL by checking under **Users** in your ZITADEL console.
|
|
|
|
* Validate attribute synchronization and lifecycle management (activation, updates, deactivation).
|
|
|
|
## Helpful Reference Links
|
|
|
|
* [Authenticate users with SAML](https://zitadel.com/docs/guides/integrate/login/saml)
|
|
|
|
* [ZITADEL: Creating Service Users](https://zitadel.com/docs/guides/manage/console/users-overview)
|
|
|
|
* [ZITADEL: Service User Authentication](https://zitadel.com/docs/guides/integrate/service-users/authenticate-service-users)
|
|
|
|
* [ZITADEL SCIM 2.0 API Endpoints](https://zitadel.com/docs/apis/scim2)
|
|
|
|
* [SCIM v2.0 (Preview) docs](https://zitadel.com/docs/guides/manage/user/scim2)
|