From f6909b753c624ff96efc500253e3acaa63c1c6c6 Mon Sep 17 00:00:00 2001 From: KaveeshaPiumini Date: Wed, 4 Dec 2024 22:39:22 +0530 Subject: [PATCH] comments addressed --- .../7.0.0/docs/apis/scim2/index.md | 2 +- en/identity-server/7.0.0/mkdocs.yml | 4 +-- .../build-scim2-user-creation-payload.md | 26 +++++-------------- 3 files changed, 10 insertions(+), 22 deletions(-) diff --git a/en/identity-server/7.0.0/docs/apis/scim2/index.md b/en/identity-server/7.0.0/docs/apis/scim2/index.md index 70ca95a463..316309c980 100644 --- a/en/identity-server/7.0.0/docs/apis/scim2/index.md +++ b/en/identity-server/7.0.0/docs/apis/scim2/index.md @@ -4,9 +4,9 @@ The SCIM2 Rest APIs of {{product_name}} implements the SCIM 2.0 protocol accordi - [SCIM 2.0 Users API]({{base_path}}/apis/scim2/scim2-users-rest-api/) - [SCIM 2.0 Groups API]({{base_path}}/apis/scim2/scim2-groups-rest-api/) +- [SCIM 2.0 Build User Creation Payload]({{base_path}}/apis/scim2/build-scim2-user-creation-payload/) - [SCIM 2.0 Patch operations]({{base_path}}/apis/scim2/scim2-patch-operations/) - [SCIM 2.0 Bulk API]({{base_path}}/apis/scim2/scim2-bulk-rest-api/) - [SCIM 2.0 Batch operations]({{base_path}}/apis/scim2/scim2-batch-operations/) - [SCIM 2.0 Resource types API]({{base_path}}/apis/scim2/scim2-resource-types/) - [SCIM 2.0 Service provider configuration API]({{base_path}}/apis/scim2/scim2-sp-config-rest-api/) -- [SCIM 2.0 Build User Creation Payload]({{base_path}}/apis/scim2/build-scim2-user-creation-payload/) diff --git a/en/identity-server/7.0.0/mkdocs.yml b/en/identity-server/7.0.0/mkdocs.yml index 5cdf2c495d..e80ee4e938 100644 --- a/en/identity-server/7.0.0/mkdocs.yml +++ b/en/identity-server/7.0.0/mkdocs.yml @@ -321,11 +321,11 @@ plugins: 'guides/authentication/app-native-authentication/configure-advanced-app-native-settings.md': 'guides/authentication/app-native-authentication/index.md' 'apis/scim2-users-rest-apis.md': 'apis/scim2/scim2-users-rest-api.md' 'apis/scim2-groups-rest-apis.md': 'apis/scim2/scim2-groups-rest-api.md' + 'apis/build-scim2-user-creation-payload.md': 'apis/scim2/build-scim2-user-creation-payload.md' 'apis/scim2-patch-operations.md': 'apis/scim2/scim2-patch-operations.md' 'apis/scim2-bulk-rest-apis.md': 'apis/scim2/scim2-bulk-rest-api.md' 'apis/scim2-batch-operations.md': 'apis/scim2/scim2-batch-operations.md' 'apis/scim2-sp-config-rest-apis.md': 'apis/scim2/scim2-sp-config-rest-api.md' - 'apis/build-scim2-user-creation-payload.md': 'apis/scim2/build-scim2-user-creation-payload.md' 'apis/organization-apis/org-scim2-bulk-mgt.md': 'apis/organization-apis/scim2/scim2-org-bulk.md' 'apis/organization-apis/org-user-mgt.md': 'apis/organization-apis/scim2/scim2-org-user-mgt.md' 'apis/organization-apis/org-group-mgt.md': 'apis/organization-apis/scim2/scim2-org-group-mgt.md' @@ -787,12 +787,12 @@ nav: - SCIM 2.0 API: apis/scim2/index.md - SCIM 2.0 Users API: apis/scim2/scim2-users-rest-api.md - SCIM 2.0 Groups API: apis/scim2/scim2-groups-rest-api.md + - SCIM 2.0 Build user creation payload: apis/scim2/build-scim2-user-creation-payload.md - SCIM 2.0 Patch operations: apis/scim2/scim2-patch-operations.md - SCIM 2.0 Bulk API: apis/scim2/scim2-bulk-rest-api.md - SCIM 2.0 Batch operations: apis/scim2/scim2-batch-operations.md - SCIM 2.0 Resource types API: apis/scim2/scim2-resource-types.md - SCIM 2.0 Service provider configuration API: apis/scim2/scim2-sp-config-rest-api.md - - SCIM 2.0 Build user creation payload: apis/scim2/build-scim2-user-creation-payload.md - Account recovery APIs: - Account recovery v0.9 API: apis/use-the-account-recovery-rest-apis.md - Account recovery v1 API (deprecated): apis/user-account-recovery-v1-rest-api.md diff --git a/en/includes/apis/scim2/build-scim2-user-creation-payload.md b/en/includes/apis/scim2/build-scim2-user-creation-payload.md index 4d8b3f2293..df9e3db540 100644 --- a/en/includes/apis/scim2/build-scim2-user-creation-payload.md +++ b/en/includes/apis/scim2/build-scim2-user-creation-payload.md @@ -1,10 +1,10 @@ # Build SCIM 2.0 User Creation Payloads -This guide explains how to build SCIM 2.0 payloads in compliance with the SCIM 2.0 specification. +This guide explains how to build SCIM 2.0 user creation payloads in compliance with the SCIM 2.0 specification. -## Step 1 : Identifying SCIM 2.0 Claims for User Attributes +## Step 1 : Identifying SCIM 2.0 Attributes for User Attributes To build a SCIM 2.0 payload, the first step is identifying the SCIM schema mapping for your user attribute: @@ -15,7 +15,7 @@ Navigate to **User Attributes & Stores** → **Attributes** → **SCIM 2.0** in - **Core Schema** - **User Schema** - **Enterprise Schema** - - **Custom Schema** {% if product_name == "WSO2 Identity Server" %} (if you have mapped any custom user attribute to a SCIM claim). {% endif %} + - **Custom Schema** {% if product_name == "WSO2 Identity Server" %} (if you have mapped any custom user attribute to a SCIM attribute in the custom schema). {% endif %} > For further details refer [Manage SCIM 2.0 attribute mappings]({{base_path}}/guides/users/attributes/manage-scim2-attribute-mappings) @@ -24,7 +24,7 @@ Navigate to **User Attributes & Stores** → **Attributes** → **SCIM 2.0** in ### Rules for Schema Usage in SCIM 2.0 Payloads -- If your user attribute is mapped to **Core Schema** or **User Schema**, the schema name does not need to be qualified in the SCIM payload. +- If your user attribute is mapped to **Core Schema** or **User Schema**, the schema URI does not need to be qualified in the SCIM payload. - If your user attribute is mapped to **Enterprise Schema** or **Custom Schema**, each SCIM attribute under these schemas must be placed under the schema’s namespace. @@ -39,11 +39,10 @@ Navigate to **User Attributes & Stores** → **Attributes** → **SCIM 2.0** in } } - ``` -## Step 2 : Attribute Types in SCIM 2.0 Payloads +## Step 2 : Identify the Attribute Types and their SCIM 2.0 Payload Format Each SCIM attribute falls into one of the following attribute types, which determine the format of the attribute in the payload. @@ -80,7 +79,7 @@ Each SCIM attribute falls into one of the following attribute types, which deter Extended attribute example: ```json { - "urn:scim:wso2:schema:userDevices": { + "urn:scim:wso2:schema:user": { "devices": ["d1", "d2"] } } @@ -121,7 +120,7 @@ Each SCIM attribute falls into one of the following attribute types, which deter ## Step 3: Determining the Type of SCIM 2.0 Attributes -The patterns described below are used for SCIM attributes to map local user attributes. SCIM claim mappings should follow these patterns for different types of SCIM attributes. +The patterns described below are used for SCIM attributes to map local user attributes. SCIM attribute mappings should follow these patterns for different types of SCIM attributes. Based on the pattern: @@ -177,7 +176,6 @@ Based on the pattern: }, "emails": [ { - "type": "home", "value": "kim@gmail.com", "primary": true }, @@ -186,16 +184,6 @@ Based on the pattern: "value": "kim@wso2.com" } ], - "addresses": [ - { - "type": "home", - "value": "123 Main St, City, Country" - }, - { - "type": "work", - "value": "456 Office Rd, City, Country" - } - ], "phoneNumbers": [ { "type": "mobile",