Skip to content

Commit

Permalink
Improved fields documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
shrihari-prakash committed Sep 11, 2024
1 parent af59430 commit c30eddf
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/docs/api-documentation/API-Documentation-Admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,7 @@ Requires delegated authentication.

#### Before You Start

Read about editing users [here](/fields-and-attributes/General-Fields#updating-fields)
Read about editing users [here](/fields-and-attributes/All-Fields#updating-fields)

#### URL

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/fields-and-attributes/All-Fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ globalLogoutAt | LOW | Date | No | No | No | No

Liquid provides granular control on who can change what fields of a user.

Most of these fields can be updated using [Update User Fields (Delegated)](/api-documentation/API-Documentation-Delegated#update-user-info) or [Update User Fields (Admin)](/api-documentation/API-Documentation-Admin#update-user-info), but some fields are special and cannot be updated directly by PATCH APIs. Such fields are related to special features of Liquid and the documentation for usage is linked in the `Related API` field of the table above.

### For delegated users

When fields are changed by a user themselves, it is possible to control which fields they can edit by listing the editable fields in the option `user.profile.editable-fields`.
Expand All @@ -93,8 +95,6 @@ By default, Liquid does not allow editing anything before assigning the sensitiv

When editing roles, the role sent in the body should be of less priority in ranking than the user that is requesting the API unless the requesting user is a super_admin. For instance, a user with role ‘user’ cannot make someone an ‘admin’.

Most of these fields can be updated using [Update User Fields (Delegated)](/api-documentation/API-Documentation-Delegated#update-user-info) or [Update User Fields (Admin)](/api-documentation/API-Documentation-Admin#update-user-info), but some fields are special and cannot be updated directly by PATCH APIs. Such fields are related to special features of Liquid and the documentation for usage is linked in the `Related API` field of the table above.

### More Fields

If these set of fields are not enough for your use case, you can extend the user object by using the [Custom Data](/fields-and-attributes/Custom-Data) mechanism.

0 comments on commit c30eddf

Please sign in to comment.