Skip to content

Commit e281c7b

Browse files
add hidden_claims config to documentation
1 parent 11f02bc commit e281c7b

File tree

1 file changed

+32
-11
lines changed

1 file changed

+32
-11
lines changed

en/includes/guides/users/attributes/manage-attributes.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -224,23 +224,23 @@ To delete an attribute:
224224
Only custom attributes can be deleted.
225225

226226
{% if product_name == "WSO2 Identity Server" %}
227-
## Manage Identity Attributes
227+
## Manage identity attributes
228228

229229
By default, identity claim values are stored in the JDBC datasource configured in the `deployment.toml` file. If required, you can configure WSO2 Identity Server to store the claim values in another user store as well.
230230

231-
1. Open the `<IS_HOME>/repository/conf/deployment.toml` file and add the following configuration to change the `identity_datastore` property value to `IdentityDataStoreService`. This service, functioning as an OSGi service, is dedicated to accessing Identity data stores.
231+
1. Open the `<IS_HOME>/repository/conf/deployment.toml` file and add the following configuration to change the `identity_datastore.datastore_type` property. The `IdentityDataStoreService` OSGi service uses this value to determine which data store implementation to access.
232232

233-
```
234-
[identity_datastore]
235-
datastore_type = "<Name of the identityDataStore class>"
236-
```
233+
```
234+
[identity_datastore]
235+
datastore_type = "<Name of the identityDataStore class>"
236+
```
237237
238-
!!! Note
239-
The class name configuration for the identity data store has been separated from the listener configurations. If you're using a custom data store class, it's crucial to update your `deployment.toml` file to reflect this choice. This update ensures that your custom class will override the default configuration.
238+
!!! Note
239+
The class name configuration for the identity data store is now separate from the listener configurations. If you're using a custom data store class, it's crucial to update your `deployment.toml` file to reflect this choice. This update ensures that your custom class will override the default configuration.
240240
241-
To either maintain the previous behavior or use your custom data store, simply follow these steps and update your deployment.toml:
241+
To either maintain the previous behavior or use your custom data store, simply follow these steps and update your deployment.toml:
242242
243-
By making this configuration adjustment, you can ensure that your system aligns with your preferred data store class, whether it's the previous default or a custom class you've implemented. This helps you tailor the system to your specific needs.
243+
By making this configuration adjustment, you can ensure that your system aligns with your preferred data store class, whether it's the previous default or a custom class you've implemented. This helps you tailor the system to your specific needs.
244244
245245
2. Map the identity claims mentioned below to attributes in the underlying user store.
246246
@@ -256,7 +256,28 @@ datastore_type = "<Name of the identityDataStore class>"
256256
257257
- `http://wso2.org/claims/identity/failedLoginAttempts`: This is
258258
used to track the number of consecutive failed login attempts.
259-
It is based on this that the account is locked.
259+
It's based on this that the account is locked.
260+
{% endif %}
261+
262+
{% if product_name == "WSO2 Identity Server" and is_version > "7.1.0" %}
263+
264+
WSO2 Identity Server includes hidden identity attributes that support internal functionality but don't appear in the Console UI by default. These attributes typically don't require mapping with Service Providers (SPs) or Identity Providers (IdPs).
265+
266+
You can customize the set of hidden identity attributes by adding the following configuration to the `<IS_HOME>/repository/conf/deployment.toml` file:
267+
268+
```
269+
[identity_mgt.claims]
270+
hidden_claims = [
271+
"<attribute_uri_1>",
272+
"<attribute_uri_2>",
273+
...
274+
]
275+
```
276+
277+
To add new attributes to the hidden list, include their URIs in the hidden_claims array.
278+
279+
To unhide default hidden attributes, override the configuration with an empty list or remove the relevant URIs.
280+
260281
{% endif %}
261282
262283
{% if multi_valued_attributes %}

0 commit comments

Comments
 (0)