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

    accountQuery string

    advsearchcriteria

    object

    accountowner

    object[]

  • Array [

  • rank string
    type string
    value string
  • ]

  • name string
    status string

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 [

  • accountID string
    accountKey number
    accountclass string

    accountowner

    object[]

  • Array [

  • rank number
    type string
    value string
  • ]

  • accounttype string
    comments string
    createdon string
    creator string
    customproperty1 string
    customproperty11 string
    customproperty19 string
    customproperty2 string
    customproperty20 string
    customproperty26 string
    customproperty3 string
    customproperty30 string
    customproperty6 string
    customproperty7 string
    endpoint string
    endpointKey number
    lastpasswordchange string
    name string
    status string
    updatedate string
    userKey string
    username string
  • ]

  • displaycount number
    errorCode string
    msg string
    total number
Loading...