Skip to content

Accounts

These objects represent the accounts (owned by employees) in your organization.

Operations

List accounts

Request

Security
x-api-key
Query
emailstring

Filter by email address. Accepts partial email addresses for wildcard searches.

appTypestring

Filter by the app associated with this account.

employeeIdstring

Filter by an employee ID associated with this account.

passwordIdstring

Filter by a password ID associated with this account.

lastUsedTimestampAfterinteger

Filter by when the account was last used by an employee - start time. This is a UNIX timestamp (in seconds).

lastUsedTimestampBeforeinteger

Filter by when the account was last used by an employee - end time. This is a UNIX timestamp (in seconds).

limitinteger, [ 1 .. 500 ]

Used for pagination. Number of objects to return.

Default:500
offsetintegerdeprecated

Used for pagination. Number of objects to skip. Cannot be set when nextToken is also set.

nextTokenstring

Used for pagination. Token to be used for the next request. Cannot be set when offset is also set.

GET
/v1/accounts
curl -i -X GET \
  https://api.pushsecurity.com/v1/accounts \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
resultArray of objects(Account)
pagingobject
Response
{
  "result": [
    {
      "id": "d6a32ba5-0532-4a66-8137-48cdf409c972",
      "employeeId": "72d0347a-2663-4ef5-b1c5-df39163f1603",
      "appType": "ATLASSIAN",
      "appId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
      "email": "john.hill@example.com",
      "mfaRegistered": true,
      "mfaMethods": [
        "APP_TOTP"
      ],
      "passwordId": "4c13674f-e88a-4411-bfa2-53a70468a898",
      "loginMethods": {
        "passwordLogin": true,
        "lastPasswordLoginTimestamp": 1698064423,
        "oidcLogin": "GOOGLE_WORKSPACE",
        "lastOidcLoginTimestamp": 1698064423,
        "samlLogin": "OKTA",
        "lastSamlLoginTimestamp": 1698064423,
        "oktaSwaLogin": true,
        "lastOktaSwaLoginTimestamp": 1698064423,
        "vendorSsoLogin": "GOOGLE_WORKSPACE",
        "fedCmLogin": "GOOGLE_WORKSPACE",
        "lastFedCmLoginTimestamp": 1698064423
      },
      "creationTimestamp": 1698064423,
      "lastUsedTimestamp": 1698669168
    }
  ],
  "paging": {
    "moreResults": true,
    "next": "501",
    "nextToken": "0b9972aa-fe8d-4095-82d3-2e13cf3cfd43"
  }
}