Skip to content

docs: document user lookup by external identity #1504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wangsijie wants to merge 1 commit into
base: master
Choose a base branch
from
+37 −0
Open

docs: document user lookup by external identity #1504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/user-management/advanced-user-search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,3 +186,40 @@ new URLSearchParams([
['joint', 'and'],
]);
```

## Look up by external identity \{#look-up-by-external-identity}

To find the user linked to a social or enterprise SSO identity, pass the following three query parameters together for an exact lookup:

- `identityType`: `social` for a social connector identity, or `sso` for an enterprise SSO identity.
- `identityProvider`: the connector target for a social identity (for example, `dingtalk`), or the issuer for an enterprise SSO identity.
- `identityId`: the user identifier issued by the external identity provider.

```javascript
// Find the user linked to a DingTalk social identity
new URLSearchParams([
['identityType', 'social'],
['identityProvider', 'dingtalk'],
['identityId', 'dingtalk-open-id'],
]);
```

```javascript
// Find the user linked to an enterprise SSO identity
new URLSearchParams([
['identityType', 'sso'],
['identityProvider', 'https://example.com/issuer'],
['identityId', 'enterprise-user-id'],
]);
```

The identity filter is combined with other search filters using AND logic. For example, to further narrow the identity lookup with a keyword search:

```javascript
new URLSearchParams([
['identityType', 'social'],
['identityProvider', 'dingtalk'],
['identityId', 'dingtalk-open-id'],
['search', '%foo%'],
]);
```
Loading