https://api.bitsighttech.com/ratings/v2/users
Create a new user. See user roles.
Parameters
* Required.
data
-
* Required.
[Body] Provide user details.
Value: [Object]
status
-
[Data] Set the account status for the user.
Value: [String] User account status.
Activated
-
↻
Created
Deactivated
group
-
[Data] Assign an Access Control Group for the user.
Value: [String] Group unique identifier [
group_guid
]. See GET: Access Control Groups. roles
-
* Required.
[Data] Set a role for the user.
Though this parameter accepts an array of role objects, only one role is accepted per request.
Value: [Array] User role slug name. See user roles.
Example:
[{"slug": "customer_user"}]
friendly_name
-
* Required.
[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 your portfolio.
Value: [Boolean]
true
= Assign the user as a subscription contact. formal_name
-
* Required.
[Data] Provide the user's full name.
Value: [String]
email
-
* Required.
[Data] Provide the user's email address. This is also used as part of their Bitsight platform login credentials.
Value: [String] Email address.
features
-
[Data] Provide the user access to select 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 -X POST --data-ascii '{"friendly_name": "Arnold","formal_name": "Arnold Brown","email": "arnold@actorsfilms.us"}' https://api.bitsighttech.com/ratings/v2/users -u api_token: --header "Content-Type:application/json"
Example Response
{ "guid":"11111111-aaaa-1111-aaaa-111111111111", "friendly_name":"Arnold", "formal_name":"Arnold Brown", "email":"arnold@actorsfilms.us", "group":{ "guid":"bbbbbbbb-2222-bbbb-2222-bbbbbbbbbbbb", "name":"All Companies" }, "status":"Created", "last_login_time":null, "joined_time":"2020-02-02T20:20:20Z", "roles":[ { "name":"User", "slug":"customer_user" } ], "is_available_for_contact":false, "is_company_api_token":false, "features":[ { "slug":"wfh-ro", "value":false, "can_update":true } ] }
Response Attributes
Field | Description | |
---|---|---|
guid String [ |
The unique identifier of this user. | |
friendly_name String |
The preferred name of this user. | |
formal_name String |
The full name of this user. | |
String |
The email address of this user. | |
group Object |
The Access Control Group of this user. | |
guid String [ |
The unique identifier of this group. | |
name String |
The name of this group. | |
status String |
The account status of this user. | |
last_login_time String [ |
The date and time when this user last logged in to the Bitsight platform. | |
joined_time String [ |
The date and time when this user was added to the Bitsight platform. | |
roles Array |
The role of this user. See user roles. | |
name String |
The name of this user role. | |
slug String |
The slug name of this user role. | |
is_available_for_contact Boolean |
true = This user is an Admin, Group Admin, or Portfolio Manager who has been assigned as a point-of-contact when other users request to add companies to the portfolio. |
|
is_company_api_token Boolean |
true = This user account is a company API token and is not an actual user. |
|
features Array |
User-managed feature details of this user. | |
slug String |
The slug name of this feature. | |
value Boolean |
true = This feature is enabled for this user. |
|
can_update Boolean |
true = This user can manage settings for this feature. |
- May 21, 2020: Published.
Feedback
0 comments
Please sign in to leave a comment.