Skip to content

Commit 54c28bb

Browse files
Merge pull request #5278 from DonOmalVindula/fix/30299
Add documentation for user creation wizard attribute profiles
2 parents d6890cf + 63e8d2a commit 54c28bb

File tree

7 files changed

+26
-14
lines changed

7 files changed

+26
-14
lines changed
Loading
Loading

en/asgardeo/docs/guides/users/manage-users.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ Let's look at how administrators can onboard users from the {{ product_name }} C
2626
- **First Name:** First name of the user. You can add/change this later.
2727
- **Last Name:** Last name of the user. You can add/change this later.
2828

29+
!!! note
30+
You can include additional user details such as phone number, address, and other custom attributes when onboarding a user. This is done via
31+
[attribute configurations]({{base_path}}/guides/users/attributes/manage-attributes/#configure-attributes).
32+
2933
!!! note
3034

3135
- A username is always unique to the organization and you can't change the username once it is created.
@@ -149,7 +153,7 @@ To resend the link/code:
149153
150154
![Resend link]({{base_path}}/assets/img/guides/users/resend-password-setup-link.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
151155
152-
Alternatively, administrators can use the resend-code API to resend the link or code as shown below.
156+
Alternatively, administrators can use the resend-code API to resend the link or code as shown below.
153157
154158
!!! abstract ""
155159
@@ -195,7 +199,7 @@ Alternatively, administrators can use the resend-code API to resend the link or
195199
]
196200
}'
197201
```
198-
202+
199203
The recovery scenario should be specified in the properties parameter of the API request body, as follows:
200204
201205
- `ASK_PASSWORD`: When the user is pending to set up an initial password using the setup link.
@@ -249,7 +253,7 @@ To reset the password:
249253
If this option is selected, the owner or an administrator can set a temporary password for the user.
250254
251255
!!! note
252-
If the user is in pending admin forced password reset, once the admin resets the password,
256+
If the user is in pending admin forced password reset, once the admin resets the password,
253257
the account will get unlocked.
254258
255259
![Reset password]({{base_path}}/assets/img/guides/users/reset-password-of-user.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
@@ -312,7 +316,7 @@ To lock a user account:
312316
Disabling a user's account prevents users from logging into applications or to the self-service My Account portal. It is intended to be a long-term and a more permanent measure than locking a user's account. Therefore, if you simply wish to restrict a user's access temporarily, it is recommended to use [account locking](#lock-a-user-account).
313317
314318
!!! note "Enable account disabling"
315-
319+
316320
Account disabling is not an option available for a user's account by default. If you wish to enable this option for your organization, refer to [account disabling]({{base_path}}/guides/account-configurations/account-disabling/).
317321
318322
To disable a user account,
Loading

en/identity-server/next/docs/guides/users/manage-users.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,16 @@ Let's look at how administrators can onboard users from the {{ product_name }} C
1818
### Onboard single user
1919

2020
1. On the {{ product_name }} Console, go to **User Management** > **Users**.
21-
2. Click **Add User** button and select **Single User** option and provide the following details:
21+
2. Click **Add User** button and select **Single User** option and provide the user's details.
2222

2323
![Add user]({{base_path}}/assets/img/guides/users/add-user-form.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
2424

2525
!!! note
26-
- A username is always unique to the organization and you can't change the username once it is created.
27-
- Instead of using a username to login, you can [configure email address as the username]({{base_path}}/guides/users/attributes/enable-email-as-username/). Then, you will be asked to enter the email address when logging in.
28-
- The user can change the password set by the administrator from the [My Account Portal]({{base_path}}/guides/user-self-service/customer-self-service-portal/).
26+
- The user's username is always unique to the organization and you can't change the username once it is created.
27+
- Optionally, you can [configure email address as the username]({{base_path}}/guides/users/attributes/enable-email-as-username/). Then, the user must enter the email address when logging in.
28+
29+
!!! tip "Add additional fields to the user onboarding form"
30+
The default form requests for basic information of the user. If you wish to include additional details, such as the user's phone number, address, and other custom attributes, you need to make these attributes available in the **Administrator Console**. Learn how to do so in [attribute configurations]({{base_path}}/guides/users/attributes/manage-attributes/#configure-attributes).
2931

3032
3. You can either request the user to set the password or set one on the user's behalf.
3133

@@ -148,7 +150,7 @@ To resend the link/code:
148150
149151
![Resend link]({{base_path}}/assets/img/guides/users/resend-password-setup-link.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
150152
151-
Alternatively, administrators can use the resend-code API to resend the link or code as shown below.
153+
Alternatively, administrators can use the resend-code API to resend the link or code as shown below.
152154
153155
!!! abstract ""
154156
@@ -194,7 +196,7 @@ Alternatively, administrators can use the resend-code API to resend the link or
194196
]
195197
}'
196198
```
197-
199+
198200
The recovery scenario should be specified in the properties parameter of the API request body, as follows:
199201
200202
- `ASK_PASSWORD`: When the user is pending to set up an initial password using the setup link.
@@ -242,7 +244,7 @@ To reset the password:
242244
If this option is selected, the owner or an administrator can set a new password for the user.
243245
244246
!!! note
245-
If the user is in pending admin forced password reset, once the admin resets the password,
247+
If the user is in pending admin forced password reset, once the admin resets the password,
246248
the account will get unlocked.
247249
248250
- **Invite user to reset the password:**
@@ -311,7 +313,7 @@ To lock a user account:
311313
Disabling a user's account prevents users from logging into applications or to the self-service My Account portal. It is intended to be a long-term and a more permanent measure than locking a user's account. Therefore, if you simply wish to restrict a user's access temporarily, it is recommended to use [account locking](#lock-a-user-account).
312314
313315
!!! note "Enable account disabling"
314-
316+
315317
Account disabling is not an option available for a users' accounts by default. If you wish to enable this option for your organization, refer to [account disabling]({{base_path}}/guides/account-configurations/account-disabling/).
316318
317319
To disable a user account,

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

+8-2
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,12 @@ To configure properties of user attributes:
136136
</tbody>
137137
</table>
138138

139+
!!! note
140+
Using the attribute configurations, you can also configure which attributes are displayed in the user creation form when
141+
[onboarding users]({{base_path}}/guides/users/manage-users/#onboard-a-single-user) in the console.
142+
143+
To display an attribute in the user creation form, select the **both** **Display** and **Required** checkboxes for the **Administrator Console** entity.
144+
139145
{% else %}
140146

141147
## Configure attributes
@@ -200,7 +206,7 @@ To configure properties of user attributes:
200206
!!! warning "Before you proceed"
201207

202208
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.
203-
209+
204210
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.
205211

206212

@@ -236,7 +242,7 @@ datastore_type = "<Name of the identityDataStore class>"
236242

237243
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.
238244

239-
2. Map the identity claims mentioned below to attributes in the underlying user store.
245+
2. Map the identity claims mentioned below to attributes in the underlying user store.
240246

241247
!!! info
242248
Learn more about [adding claim mapping]({{base_path}}/guides/dialects/add-claim-mapping).

0 commit comments

Comments
 (0)