Users API Endpoint

Retrieve a list of all Bitsight Security Ratings Platform user accounts in your organization.

GET: Users

Get a list of all the users within your account.

Path: GET /users

POST: Create a New User

Create a new user.

Path: POST /users

Version 2

GET: User Quota

Get your account’s user quota.

Path: GET /users/quota

Version 1

GET: User Details

Get account details of a user in your organization.

Path: GET /users/user_guid

PATCH: Edit a User

Edit an existing user.

Path: PATCH /users/user_guid

Version 2

DELETE: Delete a User

Delete an existing user. Deleting users cannot be undone.

Path: DELETE /users/user_guid

Version 2

GET: Your Company Views

See your company monitoring activity, including companies you have recently or most often viewed.

Path: GET /users/user_guid/company-views

Version 1

POST: Require a User to Implement 2FA

Enforce multi-factor/2-factor authentication (2FA) on a user.

Path: POST /users/user_guid/require-mfa

Version 2

POST: Resend User Activation Email

If the user has not received the Welcome to Bitsight email, which includes their activation link to access the Bitsight platform, use this endpoint to resend the activation email.

Path: POST /users/user_guid/resend-activation-email

Version 2

POST: Reset 2FA for a User

Reset a user’s multi-factor/2-factor authentication (2FA).

Path: POST /users/user_guid/reset-mfa

Version 2

  • July 10, 2023: Removed PDF.
  • April 11, 2023: GET: User Quota [/v1/users/quota]
  • August 25, 2021: POST: Reset 2FA for a User [/v2/users/user_guid/reset-mfa] and POST: Require a User to Implement 2FA [/v2/users/user_guid/require-mfa].
Was this article helpful?
1 out of 2 found this helpful

Comments

0 comments

Please sign in to leave a comment.