Skip to content

Knowledge Portal Manager APIs

License

The following licenses are required to use the Knowledge Access APIs:

  • If the user is an agent, then the Knowledge + AI license is required.
  • If the user is a customer, the Self-Service and Advanced Self-Service licenses must be available.

Tiers

TierTier NameNamed UsersDescription
Tier 1StarterUp to 10Designed for small-scale implementations or pilot environments
Tier 2GrowthUp to 1000Suitable for mid-scale deployments requiring moderate scalability
Tier 3EnterpriseGreater than 1000Supports large-scale environments with extended configuration options

API Resource Limits

The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.

ResourceLimitsStarterGrowthEnterprise
Article ReferenceNumber of attachments used in any article255050
Number of custom attributes in an article102550
Number of publish views used in an article version202020
Topic ReferenceUser-defined topics in a department1000500050000
Depth of topics52020
Topics at any level50025002500
Number of custom attributes in a topic101010
Portal ReferenceTag categories in a portal151515
Topics to be included in a portal1005005000
Number of articles to display in announcements102525
Usage links and link groups setup for a portal51025
Download OpenAPI description
Languages
Servers
Production Server
https://api.egain.cloud/knowledge/portalmgr/v4

Article

Article APIs

Operations

Article Lists

Article List APIs

Operations

Bookmark

Bookmark APIs

Operations

Guided Help

Guided Help APIs

Operations

Portal

Portal API

Operations

Suggestion

Suggestion APIs

Operations

Topic

Topic APIs

Operations

User Details

User Details APIs

Operations

Get User Details

Request

Overview

The Get User Details API retrieves details of a knowledge user.

Security
oAuthUser(Required scopes:
https://api.egain.cloud/auth/kno...
)
or oAuthOnBehalfOfUser(Required scopes:
https://api.egain.cloud/auth/kno...
)
Headers
Accept-Languagestringrequired

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Enum"en-US""es-ES""fr-FR""it-IT""de-DE""nl-NL""pt-BR""pt-PT""da-DK""ru-RU"
Example: en-US
curl -i -X GET \
  https://api.egain.cloud/knowledge/portalmgr/v4/portals/user \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
idstring[ 1 .. 9 ] characters^[1-9]\d*$

The numerical ID of the User

rolesArray of objects(Role)

Roles of the User

firstNamestring^[a-zA-Z0-9]|@|\s|:|.|_|-|&|[\x80-\xFF]{1,250...

First Name of the User

Example: "John"
lastNamestring^[a-zA-Z0-9]|@|\s|:|.|_|-|&|[\x80-\xFF]{1,250...

Last Name of the User

Example: "Doe"
hasEmailConfiguredboolean

Indicates if user has email

Response
application/json
{ "user": [ {} ] }

User Milestones

User Milestones APIs

Operations

User Profile

UserProfile APIs

Operations

Federated Search Event

Federated Search Event API

Operations

Connectors Search Events

Connectors Search Event APIs

Operations

Attachment

Attachment Upload API

Operations

Export

Content Export APIs

Operations