As of December 31st, 2023 ThreadFix 2.X has reached End of Life and is no longer supported. For any further information please contact the Success and Implementation team.

User Audit - API

/rest/{version}/users/audit


Descriptor

Value

HTTP Method

GET

Description

Returns a list of users and associated groups and roles

Required Permission

Manage Users

Version Introduced2.7.6


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.


Sample Call:

curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" https://localhost:8443/threadfix/rest/latest/users/audit

Sample Output:


{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 4,
            "name": "appUser",
            "displayName": "",
            "hasGlobalGroupAccess": false,
            "globalRole": null,
            "type": "LOCAL",
            "activeDirectory": null,
            "groups": [
                {
                    "name": "myGroup (LOCAL)",
                    "id": 1
                }
            ],
            "accessControlTeamMaps": [
                {
                    "teamName": "Team",
                    "roleName": "-",
                    "appRoles": [
                        {
                            "teamName": "Team",
                            "appName": "ACE",
                            "roleName": "Administrator",
                            "active": true
                        }
                    ]
                }
            ]
        },
        {
            "id": 2,
            "name": "myUser",
            "displayName": "",
            "hasGlobalGroupAccess": false,
            "globalRole": null,
            "type": "LOCAL",
            "activeDirectory": null,
            "groups": [],
            "accessControlTeamMaps": [
                {
                    "teamName": "Team",
                    "roleName": "Administrator",
                    "appRoles": []
                }
            ]
        },
        {
            "id": 3,
            "name": "noAccessUser",
            "displayName": "",
            "hasGlobalGroupAccess": false,
            "globalRole": null,
            "type": "LOCAL",
            "activeDirectory": null,
            "groups": [
                {
                    "name": "myGroup (LOCAL)",
                    "id": 1
                }
            ],
            "accessControlTeamMaps": []
        },
        {
            "id": 1,
            "name": "user",
            "displayName": "",
            "hasGlobalGroupAccess": true,
            "globalRole": {
                "id": 1,
                "displayName": "Administrator"
            },
            "type": "LOCAL",
            "activeDirectory": null,
            "groups": [],
            "accessControlTeamMaps": []
        }
    ]
}

www.threadfix.it | www.coalfire.com
Copyright © 2024 Coalfire. All rights reserved.

This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.