Update user associations

patch

https://sentinel.whitehatsec.com/api/users/{id}

This operation updates the assets, groups, or clients associated with a particular user, as identified by their User ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

ID for user patch operations

Query Params

fields

array of strings

Fields allows the user to specify optional fields returned in the user response
Supported values:
'client' returns client info for the user
'associatedRoles' returns role ids and names assigned to the user
'associatedCounts' returns the number of groups and assets assigned to the user
'associatedAssets' returns the assetID, clientID, and how assets are associated with the user
'associatedGroups' returns the group id, clientID, and how the groups are associated with the user
'clientAdminList' returns the list of clients for which the user is an all sites admin

fields

Body Params

Body of the request holds the data to input when updating user group associations. The user that is affected is not indicated here, but instead is specified in the id url parameter.

Responses

401

UnauthorizedResponse signals an unauthorized API access

403

ForbiddenResponse signals a request for a resource that does not exist or is not authorized

500

GenericError generic error

200PatchUserResponse provides user information for a single requested user

400BadRequestResponse indicates a request with invalid parameters