The following URI prefixes are interchangeable:

  • /data
  • /data/archive
  • /REST


Get All Users

Return a listing of all users in XNAT

GET - /data/users

Parameters:

format
  • JSON (default)
  • XML
  • HTML
  • CSV

Response:

{
    ResultSet: {
        Result: [
            {
                email: "string",
                firstname: "string",
                lastname: "string",
                login: "string",
                xnat_user_id: "integer"
            }
        ],
        title: "string",
        totalRecords: "integer" 
    }
}


Get One User

Not supported in XNAT 1.7


Return details on a specific user in XNAT.

GET - /data/user/{ID | username | email`}

Parameters:
One of these parameters must be supplied.

usernamestring
IDinteger
emailstring

Response:

{
    ResultSet: {
        Result: [
            {
                email: "string",
                enabled: "boolean",
                firstname: "string",
                lastname: "string",
                login: "string",
                userAuths: [
                    authId: "string",
                    method: "localdb"
                ],
                verified: "boolean"
            }
        ],
        title: "string",
        totalRecords: "integer" 
    }
}