feat: add organisation resource id (#58)

- the organisation resource id will be added to the scope. Users will be created in the specific organisation while the registration --------- Co-authored-by: Alexander Classen <[email protected]>
zitadel · Aug 13, 2024 · a6cba96 · a6cba96
1 parent b5ca273
commit a6cba96
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -45,6 +45,7 @@ const zitadelAuth = createZITADELAuth({
    issuer: `${myZITADELInstancesOrigin}`,
    client_id: `${myApplicationsClientID}`,
    project_resource_id: `${myApplicationsProjectResourceID}`,
+   organization_id: `${myApplicationsOrganizationID}`, // optional
 })
 ```
 
@@ -55,6 +56,9 @@ The following defaults apply:
 - If you specify a *project_resource_id*, the scopes for retrieving the users roles from the user info endpoint are added automatically.
 You can conveniently use `zitadelAuth.hasRole("someRoleKey")`.
 
+Optional:
+- add an *organization_id* to register and login users directly in the organization scope.
+
 ## Running the Example
 
 ### Recommended IDE Setup

diff --git a/lib/README.md b/lib/README.md
@@ -28,6 +28,7 @@ const zitadelAuth = createZITADELAuth({
    issuer: `${myZITADELInstancesOrigin}`,
    client_id: `${myApplicationsClientID}`,
    project_resource_id: `${myApplicationsProjectResourceID}`,
+   organization_id: `${myApplicationsOrganizationID}`, // optional
 })
 ```
 
@@ -36,4 +37,7 @@ The following defaults apply:
 - ZITADELs user info endpoint is called to enrich the user profile.
 - The access token is refreshed automatically by default before it expires.
 - If you specify a *project_resource_id*, the scopes for retrieving the users roles from the user info endpoint are added automatically.
-  You can conveniently use `zitadelAuth.hasRole("someRoleKey")`.
+  You can conveniently use `zitadelAuth.hasRole("someRoleKey")`.
+
+Optional:
+- add an organization_id to register and login users directly in the organization scope.
diff --git a/lib/src/zitadelAuth.ts b/lib/src/zitadelAuth.ts
@@ -5,6 +5,7 @@ export interface ZITADELConfig {
     client_id: string
     issuer: string
     project_resource_id?: string
+    org_id?: string
 }
 
 export function createZITADELAuth(
@@ -23,7 +24,8 @@ export function createZITADELAuth(
             (zitadelConfig.project_resource_id ?
             ` urn:zitadel:iam:org:project:id:${zitadelConfig.project_resource_id}:aud` +
             ' urn:zitadel:iam:org:projects:roles'
-            : ''),
+            : '')
+            + (zitadelConfig.org_id ? ` urn:zitadel:iam:org:id:${zitadelConfig.org_id}` : ''),
         authority: zitadelConfig.issuer,
         client_id: zitadelConfig.client_id,
         loadUserInfo: true,