×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

List users

Show basic information on all users

GET /api/:integration_name/:api_key/v2/users(.:format)

Parameters

api_key
API access key - String*
api_secret
API secret key - String*
limit
Limit to number of returned users - Integer
offset
Offset for pagination of users - Integer

Returns

HTTP 401 - Unauthorized

If api_key missing or invalid.

HTTP 400 - Bad Request

If fields missing or invalid.

HTTP 200 - Success

Returns JSON/XML-encoded struct [ total: <total number of users>, users: { <Details for given user (see example)> } ].

View Example
{
  "count": 1,
  "users": [
    {
      "id": 12,
      "secret": "top-secret"
    }
  ]
}

Notes

This can be called at any given time to get information on all users.