Skip to main content

Get User Details

POST 
/getUser

This method returns a List of Users in SSM.

The Authorization must have Bearer followed by Token.

Optional params:

username - Specify the username for which you want to get the user attribute details,

responsefields - User attributes which you want to see in the response(for encrypted values, mention ecp<1-5>, and for hashed values, mention hcp<1-5>),

max,

offset,

sort,

order - asc/desc,

manager - username,

secondarymanager - userkey OR secondaryManager - username

showsecurityanswers - "0"/"1" to display encrypted security answers for the user

 

filtercriteria - User fields based on which you want to get the user attribute details(including userkey),

OR

searchCriteria - search for a user based on the string passed (eg - “*ab*” or “*ab” or “ab*”) in their firstname, lastname, displayname and username only, example - "ab*" - This will return all users with firstname or lastname or username starting with "ab"

OR

advsearchcriteria - search for a user based on the string passed (eg - “*ab*” or “*ab” or “ab*”), example - {"username":"a*", "firstname":"*b"} - This will return all users with username starting with "a" AND firstname ending with "b". Exact match search is applicable for types boolean, users, customer. Date can be entered in format - yyyy-MM-dd.

OR

userQuery - Sample: “userQuery”:”user.customproperty1='abc' or user.displayname like '%display%'”.

Note - By default, if no responsefields param is passed, required attrs that will always return are username, email, statuskey, firstname, lastname, employeeid along with other attributes with nonblank values only.

Request​

Body

    filtercriteria

    object

    username string
    showsecurityanswers string

Responses​

Get User Details / Get User Details 2

Response Headers

  • Access-Control-Allow-Credentials

    string

  • Access-Control-Allow-Origin

    string

  • Cache-Control

    string

  • Date

    string

  • Expires

    string

  • Referrer-Policy

    string

  • Server

    string

  • Set-Cookie

    string

  • Strict-Transport-Security

    string

  • X-Content-Type-Options

    string

  • X-Frame-Options

    string

Schema

    displaycount string
    errorCode string
    msg string
    totalcount string

    userlist

    object[]

  • Array [

    • firstname string
    statuskey string
    userKey number
    username string
    accountExpired string
    accountLocked string
    city string
    companyname string
    costcenter string
    country string
    createdate string
    customer string
    customproperty1 string
    displayname string
    email string
    employeeType string
    employeeid string
    enabled string
    encryptedSecurityAnswers string
    failedTries string
    lastPasswordUpdateDate string
    lastname string
    location string
    passwordExpired string
    phonenumber string
    preferedFirstName string
    savUpdateDate string
    systemUserName string
    title string
    updatedate string
    updateuser string
    userSource string

  • ]

Loading...