Skip to content

Commit

Permalink
fix: broken anchor links (#933)
Browse files Browse the repository at this point in the history
  • Loading branch information
@charIeszhao
charIeszhao authored Dec 17, 2024
1 parent a477929 commit 9448097
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/connectors/connector-data-structure.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ There are lots of properties in connector data.

To make the data loading and updating more efficient, we store part of connector data which will be modified frequently to DB and the rest of that locally.

- _Local storage_, also known as [_ConnectorMetadata_](./#connectors-remote-storage-connector-db), is an object containing fixed properties such as logo, connector type, and so on. (:face_with_monocle: Having trouble understanding these properties? No worry, a detailed explanation comes later!)
- _Local storage_, also known as [_ConnectorMetadata_](/connectors/connector-data-structure#connectors-remote-storage-connector-db), is an object containing fixed properties such as logo, connector type, and so on. (:face_with_monocle: Having trouble understanding these properties? No worry, a detailed explanation comes later!)
- _Remote storage_ is stored in DB for the sake of relatively frequent changes on those data.

## Connector's local storage: _ConnectorMetadata_
Expand Down
2 changes: 1 addition & 1 deletion docs/user-management/advanced-user-search.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Search mode is set to `like` by default, which uses [Approximate string matching

:::note

All fuzzy search modes only support matching one value per field. If you need to match multiple values for a single field, you should use the "exact" mode. See [Exact match and case sensitivity](./#exact-match-and-case-sensitivity) for details.
All fuzzy search modes only support matching one value per field. If you need to match multiple values for a single field, you should use the "exact" mode. See [Exact match and case sensitivity](/user-management/advanced-user-search#exact-match-and-case-sensitivity) for details.

:::

Expand Down
38 changes: 19 additions & 19 deletions docs/user-management/user-data.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ Users are the core entities in the identity service. In Logto, they include basi

## User profile

Each user has a profile containing [all user information](./#property-reference).
Each user has a profile containing [all user information](/user-management#property-reference).

It consists of the following types of data:

- [Basic data](./#basic-data): is the basic info from the user profile. It stores all other _user_'s properties except for social `identities` and `custom_data`, such as user id, username, email, phone number, and when the user last signed in.
- [Social identities](./#social-identities): stores the user info retrieved from social sign-in (i.e., sign-in with a social connector), such as Facebook, GitHub, and WeChat.
- [Custom data](./#custom-data): stores additional user info not listed in the pre-defined user properties, such as user-preferred color and language.
- [Basic data](/user-management/user-data#basic-data): is the basic info from the user profile. It stores all other _user_'s properties except for social `identities` and `custom_data`, such as user id, username, email, phone number, and when the user last signed in.
- [Social identities](/user-management/user-data#social-identities): stores the user info retrieved from social sign-in (i.e., sign-in with a social connector), such as Facebook, GitHub, and WeChat.
- [Custom data](/user-management/user-data#custom-data): stores additional user info not listed in the pre-defined user properties, such as user-preferred color and language.

Here is a sample of a user's data which is retrieved from a sign-in to Facebook:

Expand Down Expand Up @@ -169,21 +169,21 @@ Once a user is suspended the pre-granted refresh tokens will be revoked immediat

The following properties (except _password_encrypted_ and _password_encryption_method_) are visible on the user profile, which means you can query them using [Management API](https://openapi.logto.io/operation/operation-getuser).

| Name | Type | Description | Unique | Required |
| ----------------------------------------------------------- | --------- | --------------------------------------------- | ------ | -------- |
| [id](./#id) | string | Unique identifier | ✅ | ✅ |
| [username](./#username) | string | Username for sign-in | ✅ | ❌ |
| [primary_email](./#primary_email) | string | Primary email | ✅ | ❌ |
| [primary_phone](./#primary_phone) | string | Primary phone number | ✅ | ❌ |
| [name](./#name) | string | Full name | ❌ | ❌ |
| [avatar](./#avatar) | string | URL pointing to user's avatar image | ❌ | ❌ |
| [identities](./#social-identities) | object | User info retrieved from social sign-in | ❌ | ✅ |
| [custom_data](./#custom-data) | object | Additional info in customizable properties | ❌ | ✅ |
| [application_id](./#application_id) | string | Application ID that the user first registered | ❌ | ✅ |
| [last_sign_in_at](./#last_signed_in_at) | date time | Timestamp when the user signed in last time | ❌ | ✅ |
| [password_encrypted](./#password_encrypted) | string | Encrypted password | ❌ | ❌ |
| [password_encryption_method](./#password_encryption_method) | string | Password encryption method | ❌ | ❌ |
| [is_suspended](./#is_suspended) | bool | User suspend mark | ❌ | ✅ |
| Name | Type | Description | Unique | Required |
| ----------------------------------------------------------------------------------- | --------- | --------------------------------------------- | ------ | -------- |
| [id](/user-management/user-data#id) | string | Unique identifier | ✅ | ✅ |
| [username](/user-management/user-data#username) | string | Username for sign-in | ✅ | ❌ |
| [primary_email](/user-management/user-data#primary_email) | string | Primary email | ✅ | ❌ |
| [primary_phone](/user-management/user-data#primary_phone) | string | Primary phone number | ✅ | ❌ |
| [name](/user-management/user-data#name) | string | Full name | ❌ | ❌ |
| [avatar](/user-management/user-data#avatar) | string | URL pointing to user's avatar image | ❌ | ❌ |
| [identities](/user-management/user-data#social-identities) | object | User info retrieved from social sign-in | ❌ | ✅ |
| [custom_data](/user-management/user-data#custom-data) | object | Additional info in customizable properties | ❌ | ✅ |
| [application_id](/user-management/user-data#application_id) | string | Application ID that the user first registered | ❌ | ✅ |
| [last_sign_in_at](/user-management/user-data#last_signed_in_at) | date time | Timestamp when the user signed in last time | ❌ | ✅ |
| [password_encrypted](/user-management/user-data#password_encrypted) | string | Encrypted password | ❌ | ❌ |
| [password_encryption_method](/user-management/user-data#password_encryption_method) | string | Password encryption method | ❌ | ❌ |
| [is_suspended](/user-management/user-data#is_suspended) | bool | User suspend mark | ❌ | ✅ |

- **Unique**: Ensures the [uniqueness](https://www.postgresql.org/docs/current/ddl-constraints.html#DDL-CONSTRAINTS-UNIQUE-CONSTRAINTS) of the values entered into a property of a database table.
- **Required**: Ensures that the values entered a property of a database table can NOT be `null`.
Expand Down

0 comments on commit 9448097

Please sign in to comment.