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

    usernamestring
    Example: lmcneil
    showsecurityanswersstring
    Example: 1

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

    displaycountstring
    Example: 1
    errorCodestring
    Example: 0
    msgstring
    Example: Successful
    totalcountstring
    Example: 1

    userlist

    object[]

  • Array [

    • firstnamestring
    Example: John
    statuskeystring
    Example: 1
    userKeynumber
    Example: 5
    usernamestring
    Example: johndoe
    accountExpiredstring
    accountLockedstring
    Example: false
    citystring
    Example: San Francisco
    companynamestring
    Example: Global Modern Services, Inc. (USA)
    costcenterstring
    Example: GMS USA
    countrystring
    Example: USA
    createdatestring
    Example: 06/08/2020T10:35:46+0000
    customerstring
    Example: testorg
    customproperty1string
    Example: 3aa5550b7fe348b98d7b5741afc65534
    displaynamestring
    Example: Logan McNeil
    emailstring
    Example: test@gmail.com
    employeeTypestring
    Example: Regular
    employeeidstring
    Example: 21001
    enabledstring
    Example: true
    encryptedSecurityAnswersstring
    Example: lhCSZZbYyxHaRZN6L9s4IPXAIwx86J87GEXwt5wIutPnEGkywv4W9UImm9u+qlk67bTNecLwHBClApo9olYBEceyC+h4gcLrjWwLOLlJ3Wc=
    failedTriesstring
    Example: 0
    lastPasswordUpdateDatestring
    Example: 07/23/2020T18:25:58+0000
    lastnamestring
    Example: McNeil
    locationstring
    Example: San Francisco
    passwordExpiredstring
    Example: false
    phonenumberstring
    Example: 415789-8904
    preferedFirstNamestring
    Example: Logan
    savUpdateDatestring
    Example: 06/08/2020T10:36:03+0000
    systemUserNamestring
    Example: lmcneil
    titlestring
    Example: Chief Human Resources Officer
    updatedatestring
    Example: 07/23/2020T18:25:58+0000
    updateuserstring
    Example: admin
    userSourcestring
    Example: 127

  • ]