UserList

Use this resource to return a list of users in the authenticated user account in either JSON or CSV format.

Method summary

HTTP Method Path Description
GET /scr/api/UserList Returns a list of users in the authenticated user account.

GET /scr/api/UserList

Description
Use this method to return a list of users in the authenticated user account in either JSON or CSV format.
Resource information
Requirements Description
Response format JSON or CSV
Requires authentication Yes. The user making the request must be an administrator.
Supports OAuth 2 client credentials Yes using a User Service ID containing User Management Category
Rate limited Not yet
Parameters
Name Location Description Required Type
format Query The format to return. Use csv to specify CSV. If this parameter is not provided, JSON is returned. No String
version Query The version of the requested API. The response might vary depending on the requested version. Possible values are:
  • 20110917
  • 20091212 (deprecated)
Currently, if this parameter is not provided, the results for the 20091212 version are returned. In a future release, this deprecated parameter will be ignored and the 20110917 version will be used.		 No. This parameter might become required in the future. String
Response for version 20110917
Example input
GET all users in the account in JSON format:
  • Using OAuth 2 client credentials:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/UserList?version=20110917"
GET all users in the account in CSV format:
  • Using OAuth 2 client credentials:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/UserList?version=20110917&format=csv"
Example output
In JSON format:
{
  "version":"20110917",
  "users":[
    {
      "name":"username1",
      "id":"7000f",
      "email":"user1_email@website.com",
      "avatarId":"70010",
      "license":"Editor",
      "admin":true,
      "date":1310654350393,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150005", "name": "department1" }
    },
    {
      "name":"username2",
      "id":"70022",
      "email":"user2_email@website.com",
      "license":"Community",
      "admin":false,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150006", "name": "department2" }
    },
    {
      "name":"username3",
      "id":"70021",
      "email":"user3_email@website.com",
      "license":"Contributor",
      "admin":false,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150007", "name": "department3" }
    },
    {
      "name":"username4",
      "id":"70020",
      "email":"user4_email@website.com",
      "license":"Viewer",
      "admin":false,
      "date":1310653543628,
      "archived":false,
      "invited":false,
      "licensed":true,
      "locked":false,
      "businessUnit":
          { "id": "150008", "name": "department4" }
    }
  ]
}
In CSV format:
"License Type","Full Name","Email Address","Business Unit","Administrator",
"Last Login / Invite / Archive Date (Eastern Standard Time)","Archived","Invited","Licensed","Locked"
Editor, "username1", "user1_email@website.com", "Department 1", Yes, "2011/07/14 02:39:10", No, No, Yes, No
Community, "username2", "user2_email@website.com", "", No, "", No, No, Yes, No
Contributor, "username3", "user3_email@website.com", "", No, "", No, No, Yes, No
Viewer, "username4", "user4_email@website.com", "", No, "2011/07/14 02:25:43", No, No, Yes, No
Response properties
version
The version of the API used to create the response.
users
The array of user objects.
user.name
The full name of the user.
user.id
The ID of the user.
user.email
The email address of the user.
user.avatarId
The ID of the user's avatar.
user.license
Contains one of the following possible values:
  • Editor
  • Contributor
  • Community
  • Viewer
user.admin
Contains one of the following possible values:
  • true if the user is an administrator
  • false if the user is not an administrator
user.date
This property depends on the values of the archived and invited properties.
  • If archived is true, then it's the date when the user was archived.
  • If invited is true, then it's the date when the user was invited.
  • In all other instances, it's the date of the user's most recent login.
  • If all the values are null, then the date property is not present.
The value is expressed in milliseconds since epoch, that is 1 January 1970 at midnight Coordinated Universal Time (UTC).
user.archived
Contains one of the following possible values:
  • true if the user is archived
  • false if the user is not archived
user.invited
Contains one of the following possible values:
  • true if the user is invited
  • false if the user is not invited
user.licensed
Contains one of the following possible values:
  • true if the user is licensed, that is the user is counted in the license used counts
  • false if the user is not counted in the license used counts
user.locked
The value is true if the user is locked out, that is the user can't log in at the moment. Otherwise, the value is false.
user.businessUnit
The department, division, workgroup, or functional area that the user works in.
Response messages
HTTP code Reason
200

The request was completed successfully.
401

The user isn't authorized to make the request.