Merge pull request #4900 from wso2/scim2-primary-email-change

Scim2 primary email change
wso2 · Dec 4, 2024 · f5d048e · f5d048e
2 parents 118c340 + 4e40d13
commit f5d048e
Show file tree

Hide file tree

Showing 4 changed files with 227 additions and 11 deletions.
diff --git a/en/identity-server/7.0.0/docs/apis/organization-apis/restapis/user-management.yaml b/en/identity-server/7.0.0/docs/apis/organization-apis/restapis/user-management.yaml
@@ -117,7 +117,9 @@ paths:
         content:
           application/scim+json:
             schema:
-              $ref: '#/components/schemas/UserObject'
+              oneOf:
+                - $ref: '#/components/schemas/UserObject'
+                - $ref: '#/components/schemas/UserObjectPassInvite'
         required: false
       responses:
         201:
@@ -484,6 +486,7 @@ paths:
 components:
   schemas:
     UserObject:
+      title: Set a password for the user
       required:
         - password
       type: object
@@ -497,20 +500,26 @@ components:
           properties:
             givenName:
               type: string
+              description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
               example: Kim
             familyName:
               type: string
+              description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
               example: Berry
         userName:
           type: string
-          example: kim
+          description: The `username` you specify will be used by the user for log in.
+          example: kim 
         password:
           type: string
-          example: MyPa33w@rd
+          description: Use this parameter to set a password for the user account. The user will be able to reset this password later. When setting the password, be sure to follow the password-validation rules configured for your organization.
+          example: aBcd!23#
         emails:
           type: array
+          description: Currently, the first email of the array (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
           example:
             - value: [email protected]
+              primary: true
             - type: work
               value: [email protected]
           items:
@@ -528,6 +537,51 @@ components:
                 value:
                   type: string
                   example: Taylor
+    UserObjectPassInvite:
+      title: Invite the user to set their own password
+      type: object
+      properties:
+        schemas:
+          type: object
+          properties: {}
+          example: []
+        name:
+          type: object
+          properties:
+            givenName:
+              type: string
+              description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
+              example: Kim
+            familyName:
+              type: string
+              description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
+              example: Berry
+        userName:
+          type: string
+          description: The `userName` you specify will be used by the user for log in.
+          example: kim
+        emails:
+          type: array
+          description: Currently, the first email (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
+          example:
+          - value: [email protected]
+            primary: true
+          items:
+            type: object
+            properties: {}
+        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
+          type: object
+          properties:
+            askPassword:
+              type: boolean
+              description: If this parameter is set to `true`, users will be allowed configure their own password. An email is sent to the specified email address, which will have instructions for the user to set the password and confirm the new user account.
+              example: true
+            manager:
+              type: object
+              properties:
+                value:
+                  type: string
+                  example: Taylor
     UserResponseObject:
       required:
         - meta

diff --git a/en/identity-server/7.0.0/docs/apis/restapis/scim2-users.yaml b/en/identity-server/7.0.0/docs/apis/restapis/scim2-users.yaml
@@ -117,7 +117,9 @@ paths:
         content:
           application/scim+json:
             schema:
-              $ref: '#/components/schemas/UserObject'
+              oneOf:
+                - $ref: '#/components/schemas/UserObject'
+                - $ref: '#/components/schemas/UserObjectPassInvite'
         required: false
       responses:
         201:
@@ -479,6 +481,7 @@ paths:
 components:
   schemas:
     UserObject:
+      title: Set a password for the user
       required:
         - password
       type: object
@@ -492,20 +495,26 @@ components:
           properties:
             givenName:
               type: string
+              description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
               example: Kim
             familyName:
               type: string
+              description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
               example: Berry
         userName:
           type: string
+          description: The `username` you specify will be used by the user for log in.
           example: kim
         password:
           type: string
-          example: MyPa33w@rd
+          description: Use this parameter to set a password for the user account. The user will be able to reset this password later. When setting the password, be sure to follow the password-validation rules configured for your organization.
+          example: aBcd!23#
         emails:
           type: array
+          description: Currently, the first email of the array (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
           example:
             - value: [email protected]
+              primary: true
             - type: work
               value: [email protected]
           items:
@@ -523,6 +532,51 @@ components:
                 value:
                   type: string
                   example: Taylor
+    UserObjectPassInvite:
+      title: Invite the user to set their own password
+      type: object
+      properties:
+        schemas:
+          type: object
+          properties: {}
+          example: []
+        name:
+          type: object
+          properties:
+            givenName:
+              type: string
+              description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
+              example: Kim
+            familyName:
+              type: string
+              description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
+              example: Berry
+        userName:
+          type: string
+          description: The `username` you specify will be used by the user for log in.
+          example: kim
+        emails:
+          type: array
+          description: Currently, the first email (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
+          example:
+          - value: [email protected]
+            primary: true
+          items:
+            type: object
+            properties: {}
+        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
+          type: object
+          properties:
+            askPassword:
+              type: boolean
+              description: If this parameter is set to `true`, users will be allowed configure their own password. An email is sent to the specified email address, which will have instructions for the user to set the password and confirm the new user account.
+              example: true
+            manager:
+              type: object
+              properties:
+                value:
+                  type: string
+                  example: Taylor        
     UserResponseObject:
       required:
         - meta

diff --git a/en/identity-server/next/docs/apis/organization-apis/restapis/user-management.yaml b/en/identity-server/next/docs/apis/organization-apis/restapis/user-management.yaml
@@ -117,7 +117,9 @@ paths:
         content:
           application/scim+json:
             schema:
-              $ref: '#/components/schemas/UserObject'
+              oneOf:
+                - $ref: '#/components/schemas/UserObject'
+                - $ref: '#/components/schemas/UserObjectPassInvite'
         required: false
       responses:
         201:
@@ -484,6 +486,7 @@ paths:
 components:
   schemas:
     UserObject:
+      title: Set a password for the user
       required:
         - password
       type: object
@@ -497,20 +500,26 @@ components:
           properties:
             givenName:
               type: string
+              description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
               example: Kim
             familyName:
               type: string
+              description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
               example: Berry
         userName:
           type: string
-          example: kim
+          description: The `username` you specify will be used by the user for log in.
+          example: kim 
         password:
           type: string
-          example: MyPa33w@rd
+          description: Use this parameter to set a password for the user account. The user will be able to reset this password later. When setting the password, be sure to follow the password-validation rules configured for your organization.
+          example: aBcd!23#
         emails:
           type: array
+          description: Currently, the first email of the array (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
           example:
             - value: [email protected]
+              primary: true
             - type: work
               value: [email protected]
           items:
@@ -528,6 +537,51 @@ components:
                 value:
                   type: string
                   example: Taylor
+    UserObjectPassInvite:
+      title: Invite the user to set their own password
+      type: object
+      properties:
+        schemas:
+          type: object
+          properties: {}
+          example: []
+        name:
+          type: object
+          properties:
+            givenName:
+              type: string
+              description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
+              example: Kim
+            familyName:
+              type: string
+              description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
+              example: Berry
+        userName:
+          type: string
+          description: The `userName` you specify will be used by the user for log in.
+          example: kim
+        emails:
+          type: array
+          description: Currently, the first email (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
+          example:
+          - value: [email protected]
+            primary: true
+          items:
+            type: object
+            properties: {}
+        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
+          type: object
+          properties:
+            askPassword:
+              type: boolean
+              description: If this parameter is set to `true`, users will be allowed configure their own password. An email is sent to the specified email address, which will have instructions for the user to set the password and confirm the new user account.
+              example: true
+            manager:
+              type: object
+              properties:
+                value:
+                  type: string
+                  example: Taylor
     UserResponseObject:
       required:
         - meta

diff --git a/en/identity-server/next/docs/apis/restapis/scim2-users.yaml b/en/identity-server/next/docs/apis/restapis/scim2-users.yaml
@@ -117,7 +117,9 @@ paths:
         content:
           application/scim+json:
             schema:
-              $ref: '#/components/schemas/UserObject'
+              oneOf:
+                - $ref: '#/components/schemas/UserObject'
+                - $ref: '#/components/schemas/UserObjectPassInvite'
         required: false
       responses:
         201:
@@ -479,6 +481,7 @@ paths:
 components:
   schemas:
     UserObject:
+      title: Set a password for the user
       required:
         - password
       type: object
@@ -492,20 +495,26 @@ components:
           properties:
             givenName:
               type: string
+              description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
               example: Kim
             familyName:
               type: string
+              description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
               example: Berry
         userName:
           type: string
-          example: kim
+          description: The `username` you specify will be used by the user for log in.
+          example: kim 
         password:
           type: string
-          example: MyPa33w@rd
+          description: Use this parameter to set a password for the user account. The user will be able to reset this password later. When setting the password, be sure to follow the password-validation rules configured for your organization.
+          example: aBcd!23#
         emails:
           type: array
+          description: Currently, the first email of the array (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
           example:
             - value: [email protected]
+              primary: true
             - type: work
               value: [email protected]
           items:
@@ -523,6 +532,51 @@ components:
                 value:
                   type: string
                   example: Taylor
+    UserObjectPassInvite:
+      title: Invite the user to set their own password
+      type: object
+      properties:
+        schemas:
+          type: object
+          properties: {}
+          example: []
+        name:
+          type: object
+          properties:
+            givenName:
+              type: string
+              description: The `givenName` you specify will be entered for the First Name attribute in the user's profile.
+              example: Kim
+            familyName:
+              type: string
+              description: The `familyName` you specify will be entered for the Last Name attribute in the user's profile.
+              example: Berry
+        userName:
+          type: string
+          description: The `userName` you specify will be used by the user for log in.
+          example: kim
+        emails:
+          type: array
+          description: Currently, the first email (without a specified type) is treated as the primary email and assigning a type to this email is not supported.
+          example:
+          - value: [email protected]
+            primary: true
+          items:
+            type: object
+            properties: {}
+        urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
+          type: object
+          properties:
+            askPassword:
+              type: boolean
+              description: If this parameter is set to `true`, users will be allowed configure their own password. An email is sent to the specified email address, which will have instructions for the user to set the password and confirm the new user account.
+              example: true
+            manager:
+              type: object
+              properties:
+                value:
+                  type: string
+                  example: Taylor
     UserResponseObject:
       required:
         - meta