Skip to content

Commit

Permalink
Merge pull request wso2#4594 from UdeshAthukorala/recommendation
Browse files Browse the repository at this point in the history
[IS-7.0] Provide recommendation to use Custom User Schema to add custom attributes
  • Loading branch information
himeshsiriwardana authored May 20, 2024
2 parents 1d93392 + 1eeb79c commit d35759b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,20 @@ The System for Cross-domain Identity Management (SCIM) is a specification that i

The SCIM 2.0 (System for Cross-Domain Identity Management) specification defines a [fixed set of default attributes](https://tools.ietf.org/html/rfc7643#section-8.2){:target="_blank"} for the user object. This set is defined to ensure the interoperability and it can cater to most of the industry's identity management requirements. However, in reality, organizations have their own attributes defined for their users which have already been used in their LDAP schemas. Therefore, SCIM is extensible enough to cope with custom attributes and uses the [Enterprise User Extension](https://tools.ietf.org/html/rfc7643#section-8.3){:target="_blank"} to support extra attributes for the SCIM user object.

WSO2 Identity Server allows users to define their own user schema in addition to the core user schema. These configured schema are then used while creating or validating user objects. This means that custom user attributes can be passed using SCIM for identity management requirements. Follow the steps given below to add a custom attribute. 
WSO2 Identity Server allows users to define their own user schema in addition to the core user schema. These configured schema are then used while creating or validating user objects. This means that custom user attributes can be passed using SCIM for identity management requirements.

!!! warning "Not recommended"
From {{product_name}} 6.0.0 onwards, it is recommended to use [SCIM2 Custom User Schema]({{base_path}}/guides/users/attributes/manage-scim2-attribute-mappings) to add custom attributes for users.

Using enterprise user extension for custom user attributes is not recommended for the following reasons:
1. According to the current model, Enterprise User Extension attributes are contained in a file. Hence, any modifications to this file will be applied at the server level.
2. As Enterprise User Extension is a defined schema, it must remain unchanged.

---

## Extend the SCIM 2.0 API using the Enterprise User Extension

Follow the steps given below to add a custom attribute using the Enterprise User Extension. 

1. Open the `scim2-schema-extension.config` file located in the `<IS_HOME>/repository/conf/` folder.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,20 @@ The System for Cross-domain Identity Management (SCIM) is a specification that i

The SCIM 2.0 (System for Cross-Domain Identity Management) specification defines a [fixed set of default attributes](https://tools.ietf.org/html/rfc7643#section-8.2){:target="_blank"} for the user object. This set is defined to ensure the interoperability and it can cater to most of the industry's identity management requirements. However, in reality, organizations have their own attributes defined for their users which have already been used in their LDAP schemas. Therefore, SCIM is extensible enough to cope with custom attributes and uses the [Enterprise User Extension](https://tools.ietf.org/html/rfc7643#section-8.3){:target="_blank"} to support extra attributes for the SCIM user object.

WSO2 Identity Server allows users to define their own user schema in addition to the core user schema. These configured schema are then used while creating or validating user objects. This means that custom user attributes can be passed using SCIM for identity management requirements. Follow the steps given below to add a custom attribute. 
WSO2 Identity Server allows users to define their own user schema in addition to the core user schema. These configured schema are then used while creating or validating user objects. This means that custom user attributes can be passed using SCIM for identity management requirements.

!!! warning "Not recommended"
From {{product_name}} 6.0.0 onwards, it is recommended to use [SCIM2 Custom User Schema]({{base_path}}/guides/users/attributes/manage-scim2-attribute-mappings) to add custom attributes for users.

Using enterprise user extension for custom user attributes is not recommended for the following reasons:
1. According to the current model, Enterprise User Extension attributes are contained in a file. Hence, any modifications to this file will be applied at the server level.
2. As Enterprise User Extension is a defined schema, it must remain unchanged.

---

## Extend the SCIM 2.0 API using the Enterprise User Extension

Follow the steps given below to add a custom attribute using the Enterprise User Extension. 

1. Open the `scim2-schema-extension.config` file located in the `<IS_HOME>/repository/conf/` folder.

Expand Down

0 comments on commit d35759b

Please sign in to comment.