You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/extend_dx/integration/people_service/api/index.md
+12-15Lines changed: 12 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,28 +8,25 @@ People Service APIs are designed to provide developers and administrators with t
8
8
9
9
People Service APIs are categorized into the following sections:
10
10
11
-
-[Authentication](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/authentication){target="_blank"}: APIs related to user authentication and session management.
12
-
-[Profiles](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/profiles){target="_blank"}: APIs related to managing user profiles, including creating, updating, and deleting profiles.
13
-
-[Schema](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/schema){target="_blank"}: APIs related to managing profile attributes and schema definitions.
14
-
-[Custom Fields](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/custom-fields){target="_blank"}: APIs related to managing custom fields for user profiles.
15
-
-[Images and Media](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/images-and-media){target="_blank"}: APIs related to managing profile images and media content.
16
-
-[Tags](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/tags){target="_blank"}: APIs related to managing tags for user profiles.
17
-
-[Search](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/search){target="_blank"}: APIs related to searching for user profiles based on specific criteria.
18
-
-[Privacy](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/privacy){target="_blank"}: APIs related to managing user privacy settings and data protection.
19
-
-[Federation and User Directories](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/federation-and-user-directories){target="_blank"}: APIs related to integrating with external user directories and federated identity providers.
20
-
-[Utils](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/utils){target="_blank"}: Utility APIs for common tasks and operations.
21
-
-[Probes](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/probes){target="_blank"}: Health check APIs for monitoring the service status and availability.
22
-
-[Search Re-Index](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/search-re-index){target="_blank"}: APIs related to retrying full or partial re-indexing for all or pending user profiles.
11
+
-[Authentication](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/Authentication){target="_blank"}: APIs related to user authentication and session management.
12
+
-[Profiles](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/People-Profiles){target="_blank"}: APIs related to managing user profiles, including creating, updating, and deleting profiles.
13
+
-[Schema](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/People-Schema){target="_blank"}: APIs related to managing profile attributes and schema definitions.
14
+
-[Custom Fields](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/People-Custom-fields){target="_blank"}: APIs related to managing custom fields for user profiles.
15
+
-[Images and Media](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/People-Images-and-media){target="_blank"}: APIs related to managing profile images and media content.
16
+
-[Tags](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/People-Tags){target="_blank"}: APIs related to managing tags for user profiles.
17
+
-[Search](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/People-Search){target="_blank"}: APIs related to searching for user profiles based on specific criteria.
18
+
-[Privacy](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/People-Privacy){target="_blank"}: APIs related to managing user privacy settings and data protection.
19
+
-[Federation and User Directories](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/Federation-User-directories){target="_blank"}: APIs related to integrating with external user directories and federated identity providers.
20
+
-[Utils](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/Utils){target="_blank"}: Utility APIs for common tasks and operations.
21
+
-[Probes](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/Probes){target="_blank"}: Health check APIs for monitoring the service status and availability.
22
+
-[Search Re-Index](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/Search-Re-Index){target="_blank"}: APIs related to retrying full or partial re-indexing for all or pending user profiles.
23
23
24
24
## OpenAPI and Swagger Explorer
25
25
26
26
People Service APIs are documented using OpenAPI, which provides a standard way to describe RESTful APIs and generate interactive documentation. The OpenAPI specification is available for each API category, allowing developers and administrators to explore the available endpoints, request and response formats, and authentication requirements.
27
27
28
28
You can check the OpenAPI documentation for People Service APIs using the Swagger Explorer tool. This tool provides an interactive interface for exploring the APIs, making it easy to understand the available endpoints and test them with sample requests.
29
29
30
-
This section shows the DX REST API explorers available for use with deployments to on-premises and container platforms. The following tables list the APIs and the URLs. Note that the URLs are relative, and you can append these URLs to your host name.
31
-
32
-
33
30
Use the following URLs to access the Swagger Explorer for People Service APIs and OpenAPI specification:
34
31
35
32
-**People Service APIs**: `<HOSTNAME>/dx/api/people/v1/explorer`
Copy file name to clipboardExpand all lines: docs/extend_dx/integration/people_service/integration/people_service_search_v2_integration.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,21 +26,21 @@ People Service automatically indexes data when changes occur. However, it does n
26
26
27
27
When creating and mutating users using the API or provisioning users through [User synchronization](../administration/user_provisioning/user_synchronization.md), the user data is indexed as needed as part of the creation or mutation process.
28
28
29
-
-[People Profile API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/profiles){target="_blank"}
29
+
-[People Profile API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/People-Profiles){target="_blank"}
30
30
31
31
- To create new user profile and index, trigger the `POST` endpoint named `/dx/api/people/v1/people`.
32
32
- To update existing user profile and indexing, trigger the `PUT` endpoint named `/dx/api/people/v1/people/{id}`.
33
33
- To delete existing user profile and indexing, trigger the `DELETE` endpoint named `/dx/api/people/v1/people/{id}`.
34
34
35
-
-[User Synchronization API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/federation-and-user-directories){target="_blank"}
35
+
-[User Synchronization API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/Federation-User-directories){target="_blank"}
36
36
37
37
- To start user synchronization and indexing, trigger the `POST` endpoint named `/dx/api/people/v1/user-directories/sync`.
38
38
39
39
### On-demand indexing
40
40
41
41
If immediate processing is required, People Service provides an indexing API that fully resynchronizes the index with the People Service user data.
42
42
43
-
-[Search Indexing API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/search-re-index){target="_blank"}
43
+
-[Search Indexing API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/Search-Re-Index){target="_blank"}
44
44
45
45
- To get details of all pending and failed user index operations, trigger the `GET` endpoint named `/dx/api/people/v1/search/index/pending`.
46
46
- To retry pending and failed user index operations, trigger the `POST` endpoint named `/dx/api/people/v1/search/index/pending`.
0 commit comments