Skip to content
Knowledge APIs
/
Portal Manager
/
/User Details

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
GET
/portals/user
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
{
  "user": [
    { … }
  ]
}