Skip to main content

Get Account Details

POST 
/getAccounts

This method returns a List of "Accounts" in SSM. The Authorization must have Bearer followed by Token. Optional params: username, endpoint, max, offset, accountQuery, advsearchcriteria - accountKey,description,comments,accounttype,status,customproperty1-customproperty56,accountID,displayName,name,creator (username),updateuser (username),validfromDate validthrough,createdon,lastlogondate,lastpasswordchange,updatedate,orphan (true/false), accountowner - with fields 1. type - user/ usergroup (mandatory), 2. value - username/ usergroup name (mandatory), 3. rank - 1 to 5 (optional) Sample - "advsearchcriteria":{ "status":"ACTIVE","name":"john*","createdon":"2016-12-13","customproperty12":"*Ro*","orphan":"true","accountowner": [ { "type": "user", "value": "janedoe", "rank": "1" } ]}, Date can be searched with 'yyyy-MM-dd', dates and boolean are exact match. Note: Any OR conditions must be used within parenthesis. For example: { "accountQuery":"(acc.status='1' or acc.comments like '%a%')", "username":"admin" }

Request​

Body

    accountQuerystring
    Example: acc.status='1'

    advsearchcriteria

    object

    accountowner

    object[]

  • Array [

    • rankstring
    Example: 1
    typestring
    Example: user
    valuestring
    Example: admin

  • ]

    • namestring
    Example: svc*
    statusstring
    Example: ACTIVE

Responses​

Get Account Details

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

    Accountdetails

    object[]

  • Array [

    • accountIDstring
    Example: CN=svcIT62341,OU=SaviyntPoC,DC=corpAD,DC=saviynt,DC=com
    accountKeynumber
    Example: 541341
    accountclassstring
    Example: top,person,organizationalPerson,user

    accountowner

    object[]

  • Array [

    • ranknumber
    Example: 1
    typestring
    Example: user
    valuestring
    Example: admin

  • ]

    • accounttypestring
    Example: Service Account
    commentsstring
    Example: Created as per request - 2430001
    createdonstring
    Example: 07/10/2020
    creatorstring
    Example: System created
    customproperty1string
    Example: svcIT62341
    customproperty11string
    Example: 12717263
    customproperty19string
    Example: 0
    customproperty2string
    Example: svcIT62341
    customproperty20string
    Example: svcIT62341@saviynt.com
    customproperty26string
    Example: CN=svcIT62341,OU=SaviyntPoC,DC=corpAD,DC=saviynt,DC=com
    customproperty3string
    Example: AdminUser
    customproperty30string
    Example: 512
    customproperty6string
    Example: svcIT62341
    customproperty7string
    Example: Saviynt
    endpointstring
    Example: SaviyntAD
    endpointKeynumber
    Example: 760
    lastpasswordchangestring
    Example: 07/10/2020
    namestring
    Example: svcIT62341
    statusstring
    Example: 1
    updatedatestring
    Example: 07/10/2020
    userKeystring
    Example:
    usernamestring
    Example:

  • ]

    • displaycountnumber
    Example: 1
    errorCodestring
    Example: 0
    msgstring
    Example: Successful
    totalnumber
    Example: 1