Merge pull request #6027 from logto-io/gao-update-changeset

chore: update changeset
logto-io · Jun 17, 2024 · 4118669 · 4118669
2 parents 59fe21a + aefe5cb
commit 4118669
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 10 deletions.
diff --git a/.changeset/smart-laws-compare.md b/.changeset/smart-laws-compare.md
@@ -8,13 +8,30 @@
 
 feature: just-in-time user provisioning for organizations
 
-This feature allows organizations to provision users when signing up with their email address or being added by Management API. If the user's email domain matches one of the organization's configured domains, the user will be automatically provisioned to the organization.
+This feature allows organizations to provision users when signing up with their email address or being added by Management API.
+
+### Email domains
+
+If the user's verified email domain matches one of the organization's configured domains, the user will be automatically provisioned to the organization.
 
 To enable this feature, you can add email domain via the Management API or the Logto Console:
 
 - We added the following new endpoints to the Management API:
-  - `GET /organizations/{organizationId}/email-domains`
-  - `POST /organizations/{organizationId}/email-domains`
-  - `PUT /organizations/{organizationId}/email-domains`
-  - `DELETE /organizations/{organizationId}/email-domains/{emailDomain}`
+  - `GET /organizations/{organizationId}/jit/email-domains`
+  - `POST /organizations/{organizationId}/jit/email-domains`
+  - `PUT /organizations/{organizationId}/jit/email-domains`
+  - `DELETE /organizations/{organizationId}/jit/email-domains/{emailDomain}`
 - In the Logto Console, you can manage email domains in the organization details page -> "Just-in-time provisioning" section.
+
+### Default organization roles
+
+You can also configure the default roles for users provisioned via this feature. The default roles will be assigned to the user when they are provisioned.
+
+To enable this feature, you can set the default roles via the Management API or the Logto Console:
+
+- We added the following new endpoints to the Management API:
+  - `GET /organizations/{organizationId}/jit/roles`
+  - `POST /organizations/{organizationId}/jit/roles`
+  - `PUT /organizations/{organizationId}/jit/roles`
+  - `DELETE /organizations/{organizationId}/jit/roles/{organizationRoleId}`
+- In the Logto Console, you can manage default roles in the organization details page -> "Just-in-time provisioning" section.
diff --git a/packages/core/src/routes/organization/index.jit.roles.openapi.json b/packages/core/src/routes/organization/index.jit.roles.openapi.json
@@ -7,7 +7,7 @@
   "paths": {
     "/api/organizations/{id}/jit/roles": {
       "get": {
-        "summary": "Get organization JIT roles",
+        "summary": "Get organization JIT default roles",
         "description": "Get organization roles that will be assigned to users during just-in-time provisioning.",
         "responses": {
           "200": {
@@ -16,7 +16,7 @@
         }
       },
       "post": {
-        "summary": "Add organization JIT roles",
+        "summary": "Add organization JIT default roles",
         "description": "Add new organization roles that will be assigned to users during just-in-time provisioning.",
         "requestBody": {
           "content": {
@@ -41,7 +41,7 @@
         }
       },
       "put": {
-        "summary": "Replace organization JIT roles",
+        "summary": "Replace organization JIT default roles",
         "description": "Replace all organization roles that will be assigned to users during just-in-time provisioning with the given data.",
         "requestBody": {
           "content": {
@@ -65,7 +65,7 @@
     },
     "/api/organizations/{id}/jit/roles/{organizationRoleId}": {
       "delete": {
-        "summary": "Remove organization JIT role",
+        "summary": "Remove organization JIT default role",
         "description": "Remove an organization role that will be assigned to users during just-in-time provisioning.",
         "responses": {
           "204": {

diff --git a/packages/phrases/src/locales/en/translation/admin-console/organization-details.ts b/packages/phrases/src/locales/en/translation/admin-console/organization-details.ts
@@ -32,7 +32,7 @@ const organization_details = {
   jit: {
     title: 'Enable just-in-time provisioning',
     description:
-      'Users can automatically join the organization and receive role assignments if their email matches specific domains, either during sign-up or when added via the Management API.',
+      'Users can automatically join the organization and receive role assignments if their verified email matches specific domains, either during sign-up or when added via the Management API.',
     email_domains: 'JIT provisioning email domains',
     email_domains_placeholder: 'Enter email domains for just-in-time provisioning',
     invalid_domain: 'Invalid domain',