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.

Remove Team Role from User - API

/rest/{version}/users/{userId}/role/team/delete

Descriptor

Value

HTTP Method

POST

Description

Removes the user permissions for the specified team.

This only removes explicit User/Team permissions, and does not affect any other permissions the user has from their global role, attached groups, and other team/app permissions.

To obtain the userId value in the endpoint, run the Get Users - API call first. The user's id value in the response is the userId value that you use in this endpoint.

 

Required Permission

Manage Users

Version Introduced

2.5.1.13

 

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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



Request POST Data Parameters

Parameter

Value

Required

Description

teamId

Integer

Yes

The ID of the team to remove permissions for.



Sample Call:

curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" --data "teamId=2" https://localhost:8443/threadfix/rest/latest/users/13/role/team/delete

Sample Output:



{ "message": "Successfully removed role mapping for user: Edea from team: Sample Team", "success": true, "responseCode": -1, "object": { "userId": 13, "teamId": 2 } }



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.