Skip to main content

Get User Details​

Select

SaaS
Customer Managed

Get details of a User based on id

Path Parameters
  • userId int32 required

    Id of the User whose details have to be fetched

Header Parameters
  • mode

    Possible values: [EdgeMode]

Responses

Success

Schema
  • id int32
  • name string
  • GUID string
  • fullName string
  • email string
  • enabled boolean
  • lockInfo object
  • isLocked boolean

    Returns if the user is locked or unlocked.

  • startTime int32

    If the user is locked, it returns user lock start time in unix time format.

  • endTime int32

    If the user is locked, it returns user lock end time in unix time format.

  • description string

    Returns the description of the user which was specified at the time of user creation or modification.

  • serviceType string

    Possible values: [UNKNOWN, COMMSERVE, ACTIVE_DIRECTORY, DOMINO_DIRECTORTY_SERVICE, HOSTED_EXCHANGE, ORGANIZATIONS, DUMMY_DOMAIN]

    The values that are returned by serviceType are- 0(unknown),1(commserver users),2(Active directory users),3(domino directory service users),4(hosted exchange users),5(company users),12(dummy domain users)

  • lastLoggedIn int64

    Returns the most recent time the user was logged in. It is provided in unix format.

  • company object
  • id int32
  • name string
  • plan object
  • id int32
  • name string
  • authenticationMethod string

    Specifies authentication method used by user. Default value is Commcell.

  • authenticationMethodServer object
  • id int32
  • name string
  • company object
  • id int32
  • name string
  • associatedUserGroups object[]
  • id int32
  • name string
  • provider object
  • id int32
  • name string
  • userPrincipalName string
GET /v4/user/:userid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
userId — path required
mode — header
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/user/:userId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'