Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

See more

PATCH: Edit a User

Avatar
Ingrid
Follow
Publication Date – May 21, 2020

⇤ Users

https://api.bitsighttech.com/ratings/v2/users/user_guid

Edit an existing user.

Only Admin can edit users. See user management permissions.

Parameters

*Required.

Parameter Description Values 
user_guid
Path		 Identify the user to edit. [String] User unique identifier [user_guid]. See GET: Users. 
data
Body		 The user details to edit. [Object]
  
group
Data		 Assign an Access Control Group for the user. [String] Group unique identifier [group_guid]. See GET: Access Control Groups. 
roles
Data		 Set a role for the user.

[String] User role slug name. See user roles.

Example: [{"slug": "customer_user"}]

Though this parameter accepts an array of role objects, only one role is accepted per request.

 
friendly_name
Data		 The preferred name for the user. [String] 
is_company_api_token
Data		 Assign the user as a company API token. [Boolean] true = Assign the user as a company API token. 
is_available_for_contact
Data		 Assign the user as a subscription contact when other users request to add companies to the portfolio. [Boolean] true = Assign the user as a subscription contact.

See user management permissions.

 
formal_name
Data		 The full name for the user. [String] 
email
Data		 The email address for the user. This is also used as part of their Bitsight platform login credentials. [String] 
features
Data		 Update user-managed features. [Array] Feature slug name and value parameter. See features.
Example: [{"slug": "wfh-ro", "value": true}]
 
value
Data		 Specify if a feature is enabled. [Boolean] true = Enable the selected feature.

Example Request

cURL:

curl 'https://api.bitsighttech.com/ratings/v2/users/james123-4567-8900-0098-7654321james' -u api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{"group":"88888888-eeee-8888-eeee-888888888888","email":"emma@blueseas.com"}' --compressed

JSON:

{
  "group":"88888888-eeee-8888-eeee-888888888888",
  "email":"emma@blueseas.com"
}

Related articles