From 3462a46934f7b5e6aad69053b08b809bb0e937f5 Mon Sep 17 00:00:00 2001 From: Amanda Ariyaratne Date: Thu, 7 Nov 2024 12:04:00 +0530 Subject: [PATCH 1/3] update claim management related docs --- .../organization-apis/restapis/claim-management.yaml | 5 +++++ .../apis/organization-apis/restapis/claim-mgt.yaml | 5 +++++ .../next/docs/apis/restapis/claim-management.yaml | 11 ++++++++--- .../guides/users/attributes/manage-attributes.md | 10 ++++++++++ .../attributes/manage-oidc-attribute-mappings.md | 12 +++++++++++- .../attributes/manage-scim2-attribute-mappings.md | 12 +++++++++++- 6 files changed, 50 insertions(+), 5 deletions(-) diff --git a/en/asgardeo/docs/apis/organization-apis/restapis/claim-management.yaml b/en/asgardeo/docs/apis/organization-apis/restapis/claim-management.yaml index 81e3763bee..b4c4af498e 100644 --- a/en/asgardeo/docs/apis/organization-apis/restapis/claim-management.yaml +++ b/en/asgardeo/docs/apis/organization-apis/restapis/claim-management.yaml @@ -503,6 +503,11 @@ components: type: string description: The local claim URI to map with the external claim. example: http://wso2.org/claims/username + properties: + type: array + description: Define any additional properties if required. + items: + $ref: '#/components/schemas/Property' description: External claim response. Property: required: diff --git a/en/identity-server/next/docs/apis/organization-apis/restapis/claim-mgt.yaml b/en/identity-server/next/docs/apis/organization-apis/restapis/claim-mgt.yaml index a50c98a4c6..fd807937bb 100644 --- a/en/identity-server/next/docs/apis/organization-apis/restapis/claim-mgt.yaml +++ b/en/identity-server/next/docs/apis/organization-apis/restapis/claim-mgt.yaml @@ -507,6 +507,11 @@ components: type: string description: The local claim URI to map with the external claim. example: http://wso2.org/claims/username + properties: + type: array + description: Define any additional properties if required. + items: + $ref: '#/components/schemas/Property' description: External claim response. Property: required: diff --git a/en/identity-server/next/docs/apis/restapis/claim-management.yaml b/en/identity-server/next/docs/apis/restapis/claim-management.yaml index 74d2c604ac..e2410da268 100644 --- a/en/identity-server/next/docs/apis/restapis/claim-management.yaml +++ b/en/identity-server/next/docs/apis/restapis/claim-management.yaml @@ -300,7 +300,7 @@ paths: tags: - management summary: Delete a local claim - description: Delete a claim by claim ID.
+ description: Delete a claim by claim ID. Only custom claims can be deleted.

Scope(Permission) required: `internal_claim_meta_delete` operationId: deleteLocalClaim parameters: @@ -572,7 +572,7 @@ paths: tags: - management summary: Delete a claim dialect - description: Delete a claim dialect by claim ID.
+ description: Delete a claim dialect by claim ID. Only custom claim dialects can be deleted.

Scope(Permission) required: `internal_claim_meta_delete` operationId: deleteClaimDialect parameters: @@ -1013,7 +1013,7 @@ paths: tags: - management summary: Delete an external claim - description: Delete a claim by dialect ID and claim ID.
+ description: Delete a claim by dialect ID and claim ID. Only custom claims can be deleted.

Scope(Permission) required: `internal_claim_meta_delete` operationId: deleteExternalClaim parameters: @@ -1242,6 +1242,11 @@ components: type: string description: The local claim URI to map with the external claim. example: http://wso2.org/claims/username + properties: + type: array + description: Define any additional properties if required. + items: + $ref: '#/components/schemas/Property' description: External claim response. Property: required: diff --git a/en/includes/guides/users/attributes/manage-attributes.md b/en/includes/guides/users/attributes/manage-attributes.md index 27c424bb32..82991e81f0 100644 --- a/en/includes/guides/users/attributes/manage-attributes.md +++ b/en/includes/guides/users/attributes/manage-attributes.md @@ -49,6 +49,16 @@ To add a custom attribute: 4. Click **Finish**. +{% if product_name == "WSO2 Identity Server" and is_version != "7.0.0" %} +!!! note + The set of attributes provided out of the box cannot be removed. Only custom attributes can be deleted. +{% endif %} + +{% if product_name == "Asgardeo" %} +!!! note + The default set of attributes in your organization cannot be removed. Only custom attributes can be deleted. +{% endif %} + ## Update attributes To update the properties of a user attribute: diff --git a/en/includes/guides/users/attributes/manage-oidc-attribute-mappings.md b/en/includes/guides/users/attributes/manage-oidc-attribute-mappings.md index 6c61dd9b17..92310d603d 100644 --- a/en/includes/guides/users/attributes/manage-oidc-attribute-mappings.md +++ b/en/includes/guides/users/attributes/manage-oidc-attribute-mappings.md @@ -86,4 +86,14 @@ To delete the OpenID Connect attributes available in your organization: 2. Under **Manage Attribute Mappings**, click **OpenID Connect**. 3. Select the attribute you wish to delete. 3. Click **Delete** and select the checkbox to confirm your action. -4. Click **Confirm**. \ No newline at end of file +4. Click **Confirm**. + +{% if product_name == "WSO2 Identity Server" and is_version != "7.0.0" %} +!!! note + The set of OpenID Connect attributes provided out of the box cannot be removed. Only custom attributes can be deleted. +{% endif %} + +{% if product_name == "Asgardeo" %} +!!! note + The default set of OpenID Connect attributes in your organization cannot be removed. Only custom attributes can be deleted. +{% endif %} diff --git a/en/includes/guides/users/attributes/manage-scim2-attribute-mappings.md b/en/includes/guides/users/attributes/manage-scim2-attribute-mappings.md index 31c103731f..9038ce6671 100644 --- a/en/includes/guides/users/attributes/manage-scim2-attribute-mappings.md +++ b/en/includes/guides/users/attributes/manage-scim2-attribute-mappings.md @@ -50,4 +50,14 @@ To delete the SCIM 2.0 custom schema attributes available in your organization: 2. Under **Manage Attribute Mappings**, click **SCIM 2.0**. 3. Navigate to the **Custom Schema** tab and select the attribute to delete. 3. Click **Delete** and select the checkbox to confirm you action. -4. Click **Confirm**. \ No newline at end of file +4. Click **Confirm**. + +{% if product_name == "WSO2 Identity Server" and is_version != "7.0.0" %} +!!! note + The set of SCIM 2.0 attributes provided out of the box cannot be removed. Only custom attributes can be deleted. +{% endif %} + +{% if product_name == "Asgardeo" %} +!!! note + The default set of SCIM 2.0 attributes in your organization cannot be removed. Only custom attributes can be deleted. +{% endif %} \ No newline at end of file From 8c6e5ddb120d652e9427d53b7bbeb23e6f73e3f0 Mon Sep 17 00:00:00 2001 From: Amanda Ariyaratne Date: Mon, 11 Nov 2024 16:56:05 +0530 Subject: [PATCH 2/3] add delete attribute section --- .../users/attributes/manage-attributes.md | 30 ++++++++++++------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/en/includes/guides/users/attributes/manage-attributes.md b/en/includes/guides/users/attributes/manage-attributes.md index 82991e81f0..95e704ad17 100644 --- a/en/includes/guides/users/attributes/manage-attributes.md +++ b/en/includes/guides/users/attributes/manage-attributes.md @@ -49,16 +49,6 @@ To add a custom attribute: 4. Click **Finish**. -{% if product_name == "WSO2 Identity Server" and is_version != "7.0.0" %} -!!! note - The set of attributes provided out of the box cannot be removed. Only custom attributes can be deleted. -{% endif %} - -{% if product_name == "Asgardeo" %} -!!! note - The default set of attributes in your organization cannot be removed. Only custom attributes can be deleted. -{% endif %} - ## Update attributes To update the properties of a user attribute: @@ -105,3 +95,23 @@ To update the properties of a user attribute: 6. Go to the **Additional Properties** tab and add additional properties that can be used when writing an extension. ![Edit additional properties]({{base_path}}/assets/img/guides/organization/attributes/edit-attributes-additional-properties.png){: width="500" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} + +## Delete attributes +To delete an attribute: + +1. On the {{ product_name }} Console, go to {{ attribute_path }} > **Attributes**. +2. Click **Attributes** to see the list of attributes. +3. Select the attribute you wish to delete. +4. Click **Delete attribute** under the **Danger Zone**. +5. Select the checkbox to confirm your action. +6. Click **Confirm**. + +{% if product_name == "WSO2 Identity Server" and is_version != "7.0.0" %} +!!! note + The set of attributes provided out of the box cannot be removed. Only custom attributes can be deleted. +{% endif %} + +{% if product_name == "Asgardeo" %} +!!! note + The default set of attributes in your organization cannot be removed. Only custom attributes can be deleted. +{% endif %} \ No newline at end of file From 19b85924fa74a9a2a5bd6c8d6532089958607c2b Mon Sep 17 00:00:00 2001 From: himeshsiriwardana Date: Tue, 12 Nov 2024 12:05:53 +0530 Subject: [PATCH 3/3] feedback on attribute management content --- .../users/attributes/manage-attributes.md | 18 ++++++++++-------- .../manage-oidc-attribute-mappings.md | 10 ++-------- .../manage-scim2-attribute-mappings.md | 9 +-------- 3 files changed, 13 insertions(+), 24 deletions(-) diff --git a/en/includes/guides/users/attributes/manage-attributes.md b/en/includes/guides/users/attributes/manage-attributes.md index 95e704ad17..a944f0bed3 100644 --- a/en/includes/guides/users/attributes/manage-attributes.md +++ b/en/includes/guides/users/attributes/manage-attributes.md @@ -97,21 +97,23 @@ To update the properties of a user attribute: ![Edit additional properties]({{base_path}}/assets/img/guides/organization/attributes/edit-attributes-additional-properties.png){: width="500" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} ## Delete attributes + +!!! warning "Before you proceed" + + Attributes cannot be deleted if it has any associations with external schema. If you have attribute mappings, make sure you delete these associations before attempting to delete an attribute. + + Refer to [Delete an OpenID Connect attribute]({{base_path}}/guides/users/attributes/manage-oidc-attribute-mappings/#delete-an-openid-connect-attribute) and [Delete a SCIM2 attribute]({{base_path}}/guides/users/attributes/manage-scim2-attribute-mappings/#delete-a-scim-20-custom-schema-attribute) to delete any existing associations. + + To delete an attribute: 1. On the {{ product_name }} Console, go to {{ attribute_path }} > **Attributes**. 2. Click **Attributes** to see the list of attributes. 3. Select the attribute you wish to delete. -4. Click **Delete attribute** under the **Danger Zone**. +4. Click **Delete attribute** within the **Danger Zone**. 5. Select the checkbox to confirm your action. 6. Click **Confirm**. -{% if product_name == "WSO2 Identity Server" and is_version != "7.0.0" %} !!! note - The set of attributes provided out of the box cannot be removed. Only custom attributes can be deleted. -{% endif %} -{% if product_name == "Asgardeo" %} -!!! note - The default set of attributes in your organization cannot be removed. Only custom attributes can be deleted. -{% endif %} \ No newline at end of file + Only custom attributes can be deleted. diff --git a/en/includes/guides/users/attributes/manage-oidc-attribute-mappings.md b/en/includes/guides/users/attributes/manage-oidc-attribute-mappings.md index 92310d603d..77e5975631 100644 --- a/en/includes/guides/users/attributes/manage-oidc-attribute-mappings.md +++ b/en/includes/guides/users/attributes/manage-oidc-attribute-mappings.md @@ -88,12 +88,6 @@ To delete the OpenID Connect attributes available in your organization: 3. Click **Delete** and select the checkbox to confirm your action. 4. Click **Confirm**. -{% if product_name == "WSO2 Identity Server" and is_version != "7.0.0" %} !!! note - The set of OpenID Connect attributes provided out of the box cannot be removed. Only custom attributes can be deleted. -{% endif %} - -{% if product_name == "Asgardeo" %} -!!! note - The default set of OpenID Connect attributes in your organization cannot be removed. Only custom attributes can be deleted. -{% endif %} + + Only custom attributes can be deleted. diff --git a/en/includes/guides/users/attributes/manage-scim2-attribute-mappings.md b/en/includes/guides/users/attributes/manage-scim2-attribute-mappings.md index 9038ce6671..7fb3387a21 100644 --- a/en/includes/guides/users/attributes/manage-scim2-attribute-mappings.md +++ b/en/includes/guides/users/attributes/manage-scim2-attribute-mappings.md @@ -52,12 +52,5 @@ To delete the SCIM 2.0 custom schema attributes available in your organization: 3. Click **Delete** and select the checkbox to confirm you action. 4. Click **Confirm**. -{% if product_name == "WSO2 Identity Server" and is_version != "7.0.0" %} !!! note - The set of SCIM 2.0 attributes provided out of the box cannot be removed. Only custom attributes can be deleted. -{% endif %} - -{% if product_name == "Asgardeo" %} -!!! note - The default set of SCIM 2.0 attributes in your organization cannot be removed. Only custom attributes can be deleted. -{% endif %} \ No newline at end of file + Only custom attributes can be deleted. \ No newline at end of file