PATCH: Edit a User

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

Edit an existing user.

Parameters

* Required.

user_guid

* Required.

[Path] Identify the user to edit.

Value: [String] User unique identifier [user_guid]. See GET: Users.

data

[Body] Provide the user details to edit.

Value: [Object]

group

[Data] Assign an Access Control Group for the user.

Value: [String] Group unique identifier [group_guid]. See GET: Access Control Groups.

roles

[Data] Set a role for the user.

Value: [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] Provide the preferred name for the user.

Value: [String]

is_company_api_token

[Data] Assign the user as a company API token.

Value: [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.

Value: [Boolean] true = Assign the user as a subscription contact.

formal_name

[Data] Provide the full name for the user.

Value: [String]

email

[Data] Provide the email address for the user. This is also used as part of their Bitsight platform login credentials.

Value: [String]

features

[Data] Update user-managed features.

Value: [Array] Feature slug name and value parameter. See features.

Example: [{"slug": "wfh-ro", "value": true}]

value

[Data] Specify if a feature is enabled.

Value: [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"
}