Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
/rest/{version}/users/list
Descriptor | Value |
|---|---|
HTTP Method | GET |
Description | Returns a list of users. |
Required Permission | Manage Users |
| Version Introduced | 2.5.1.12 |
| Changes in 2.5.2 | Added activeDirectory element to the response. This field is present when using any previous REST version as well. |
Request Header Parameters
Parameter | Value | Required | Description |
|---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Sample Call:
| Code Block | ||
|---|---|---|
| ||
curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" https://localhost:8443/threadfix/rest/latest/users/list |
Sample Output:
| Code Block | ||
|---|---|---|
| ||
{
"message": "",
"success": true,
"responseCode": -1,
"object": [
{
{ "id": 2,
"name": "Albert",
"displayName": "",
"type": "LOCAL",
"activeDirectory": null
},
{
{ "id": 3,
"name": "mfreemanaant",
"displayName": "MorganAdam",
"type": "LDAP",
"activeDirectory": {
"id": 111,
"name": "AWS Instance 1"
}
},
{
"id": 4,
"name": "mfreeman",
"displayName": "Morgan",
"type": "LOCAL",
"activeDirectory": null
},
{
"id": 5,
"name": "mfreemanthreadfix",
"displayName": "MorganThreadfix Service",
"type": "LDAP",
"SAMLactiveDirectory": null
},
{
"id": 1,
"name": "user",
"displayName": null,
"type": "LOCAL",
"activeDirectory": null
}
]
} |
| Page Tree | ||
|---|---|---|
|