User Management API V2

Retrieve user details, such as IAM roles, RBAC roles, and product access for your organization. You can also update user access.

Get user details

GET /user/v2/user-detail

Retrieve detailed information about users in your organization, including their IAM roles, RBAC roles, product access levels, and status. You can filter by specific email addresses or retrieve paginated results for all users.

Request parameters

Request (Without email ID)

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/user/v2/user-detail" \
-H "Content-Type: application/json" \

Request (With email ID)

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/user/v2/user-detail?email=rbac1@bsstag.com&page=1" \
-H "Content-Type: application/json"

email (Optional) string

Filter results by specific user email address. You can provide multiple email addresses separated by commas. If you do not specify an email address, the response returns details for all users.
page (Optional) integer

Page number for pagination.

Response attributes `200` `application/json`

Response (Without email ID)

{
    "count": 5,
    "user_details": [
        {
            "id": 240,
            "username": "giefame_VNh36g",
            "full_name": "gie1 fame1",
            "email": "rbac1@bsstag.com",
            "role": "admin",
            "organization_name": "asd",
            "accessType": {
                "live_testing": "Member",
                "automate": "Member",
                "app_live_testing": "Member",
                "app_automate": "Member",
                "percy": "Member",
                "app_low_code_automation": "Member",
                "accessibility_design_toolkit": "Member",
                "testing_toolkit": "Member",
                "central_scanner": "Member",
                "requestly": "Member",
                "bug_capture": "Member",
                "app_accessibility_testing": "Member",
                "automate_turboscale": "Member",
                "low_code_automation": "Member",
                "test_management": "Member",
                "accessibility_testing": "Member",
                "test_observability": "Member",
                "app_percy": "Member"
            },
            "rbacRole": "Admin",
            "product_access": {
                "live_testing": false,
                "automate": false,
                "app_live_testing": false,
                "app_automate": false,
                "percy": true,
                "accessibility_design_toolkit": false,
                "testing_toolkit": false,
                "central_scanner": false,
                "requestly": false,
                "bug_capture": false,
                "app_accessibility_testing": false,
                "automate_turboscale": false,
                "low_code_automation": false,
                "test_management": false,
                "accessibility_testing": false,
                "test_observability": true,
                "app_percy": true
            }
        },
        {
            "id": 241,
            "username": "giefame_ZSCNjf",
            "full_name": "gie1 fame1",
            "email": "rbac2@bsstag.com",
            "role": "admin",
            "organization_name": "asd",
            "accessType": {
                "live_testing": "Member",
                "automate": "Member",
                "app_live_testing": "Member",
                "app_automate": "Member",
                "percy": "Member",
                "app_low_code_automation": "Member",
                "accessibility_design_toolkit": "Member",
                "testing_toolkit": "Member",
                "central_scanner": "Member",
                "requestly": "Member",
                "bug_capture": "Member",
                "app_accessibility_testing": "Member",
                "automate_turboscale": "Member",
                "low_code_automation": "Member",
                "test_management": "Member",
                "accessibility_testing": "Member",
                "test_observability": "Member",
                "app_percy": "Member"
            },
            "rbacRole": "Admin",
            "product_access": {
                "live_testing": false,
                "automate": false,
                "app_live_testing": false,
                "app_automate": false,
                "percy": true,
                "accessibility_design_toolkit": false,
                "testing_toolkit": false,
                "central_scanner": false,
                "requestly": false,
                "bug_capture": false,
                "app_accessibility_testing": false,
                "automate_turboscale": false,
                "low_code_automation": false,
                "test_management": false,
                "accessibility_testing": false,
                "test_observability": true,
                "app_percy": true
            }
        },
        {
            "id": 242,
            "username": "giefame_wRaNUJ",
            "full_name": "gie1 fame1",
            "email": "rbac3@bsstag.com",
            "role": "admin",
            "organization_name": "asd",
            "accessType": {
                "live_testing": "Member",
                "automate": "Member",
                "app_live_testing": "Member",
                "app_automate": "Member",
                "percy": "Member",
                "app_low_code_automation": "Member",
                "accessibility_design_toolkit": "Member",
                "testing_toolkit": "Member",
                "central_scanner": "Member",
                "requestly": "Member",
                "bug_capture": "Member",
                "app_accessibility_testing": "Member",
                "automate_turboscale": "Member",
                "low_code_automation": "Member",
                "test_management": "Member",
                "accessibility_testing": "Member",
                "test_observability": "Member",
                "app_percy": "Member"
            },
            "rbacRole": "Admin",
            "product_access": {
                "live_testing": false,
                "automate": false,
                "app_live_testing": false,
                "app_automate": false,
                "percy": true,
                "accessibility_design_toolkit": false,
                "testing_toolkit": false,
                "central_scanner": false,
                "requestly": false,
                "bug_capture": false,
                "app_accessibility_testing": false,
                "automate_turboscale": false,
                "low_code_automation": false,
                "test_management": false,
                "accessibility_testing": false,
                "test_observability": true,
                "app_percy": true
            }
        },
        {
            "id": 243,
            "username": "giefame_b1DUvB",
            "full_name": "gie1 fame1",
            "email": "rbac4@bsstag.com",
            "role": "admin",
            "organization_name": "asd",
            "accessType": {
                "live_testing": "Member",
                "automate": "Member",
                "app_live_testing": "Member",
                "app_automate": "Member",
                "percy": "Member",
                "app_low_code_automation": "Member",
                "accessibility_design_toolkit": "Member",
                "testing_toolkit": "Member",
                "central_scanner": "Member",
                "requestly": "Member",
                "bug_capture": "Member",
                "app_accessibility_testing": "Member",
                "automate_turboscale": "Member",
                "low_code_automation": "Member",
                "test_management": "Member",
                "accessibility_testing": "Member",
                "test_observability": "Member",
                "app_percy": "Member"
            },
            "rbacRole": "Admin",
            "product_access": {
                "live_testing": false,
                "automate": false,
                "app_live_testing": false,
                "app_automate": false,
                "percy": true,
                "accessibility_design_toolkit": false,
                "testing_toolkit": false,
                "central_scanner": false,
                "requestly": false,
                "bug_capture": false,
                "app_accessibility_testing": false,
                "automate_turboscale": false,
                "low_code_automation": false,
                "test_management": false,
                "accessibility_testing": false,
                "test_observability": true,
                "app_percy": true
            }
        },
        {
            "id": 45,
            "username": "",
            "full_name": "",
            "email": "a@a.com",
            "role": "user",
            "organization_name": "asd",
            "accessType": {
                "live_testing": "Member",
                "automate": "Member",
                "app_live_testing": "Member",
                "app_automate": "Member",
                "percy": "Member",
                "app_low_code_automation": "Member",
                "accessibility_design_toolkit": "Member",
                "testing_toolkit": "Member",
                "central_scanner": "Member",
                "requestly": "Member",
                "bug_capture": "Member",
                "app_accessibility_testing": "Member",
                "automate_turboscale": "Member",
                "low_code_automation": "Member",
                "test_management": "Member",
                "accessibility_testing": "Member",
                "test_observability": "Member",
                "app_percy": "Member"
            },
            "rbacRole": "Admin",
            "status": "pending",
            "product_access": {
                "live_testing": false,
                "automate": true,
                "app_live_testing": true,
                "app_automate": true,
                "percy": true,
                "accessibility_design_toolkit": true,
                "testing_toolkit": true,
                "central_scanner": true,
                "requestly": true,
                "bug_capture": true,
                "app_accessibility_testing": true,
                "automate_turboscale": true,
                "low_code_automation": true,
                "test_management": false,
                "accessibility_testing": true,
                "test_observability": true,
                "app_percy": true
            }
        }
    ],
    "pagination": {
        "current_page": 2,
        "per_page": 15,
        "total_pages": 2,
        "total_count": 20
    }
}

Response (With email ID)

{
  "id": 870570,
  "username": "michael_clark",
  "full_name": "Michael Clark",
  "email": "michael.clark@example.com",
  "role": "user",
  "organization_name": "Test Group",
  "accessType": {
    "live_testing": "Member",
    "automate": "Member",
    "app_live_testing": "Member",
    "app_automate": "Member",
    "percy": "Member",
    "app_low_code_automation": "Member",
    "accessibility_design_toolkit": "Member",
    "testing_toolkit": "Member",
    "central_scanner": "Member",
    "requestly": "Member",
    "bug_capture": "Member",
    "app_accessibility_testing": "Member",
    "automate_turboscale": "Member",
    "low_code_automation": "Member",
    "test_management": "Member",
    "accessibility_testing": "Member",
    "test_observability": "Member",
    "app_percy": "Member"
  },
  "status": "pending",
  "product_access": {
    "live_testing": true,
    "automate": true,
    "app_live_testing": true,
    "app_automate": true,
    "percy": true,
    "app_low_code_automation": true,
    "accessibility_design_toolkit": true,
    "testing_toolkit": true,
    "website_scanner": true,
    "requestly": true,
    "bug_capture": false,
    "app_accessibility_testing": true,
    "automate_self_hosted": true,
    "low_code_automation": true,
    "test_management": false,
    "accessibility_testing": true,
    "test_reporting_&_analytics": true,
    "app_percy": true
  }
}

count Integer

Total number of users returned in the current response.
user_details Array

Array of user objects containing detailed information.

▶ SHOW VALUES
- id Integer
  
  Unique identifier for the user.
- username String
  
  Username of the user.
- full_name String
  
  Full name of the user.
- email String
  
  Email address of the user.
- role String
  
  IAM role assigned to the user. Possible values are admin, user, or owner.
- organization_name String
  
  Name of the organization the user belongs to.
- accessType Object
  
  Product access levels for the user. Each product can have values Member or Guest.
- rbacRole String
  
  RBAC role assigned to the user. Possible values are Admin, User, or Viewer.
- status String
  
  Status of the user invitation. Value pending indicates the user has not accepted the invitation. This field is optional and only present for users with pending invitations.
- product_access Object
  
  Boolean values indicating whether the user has access to each product. true means access is enabled, false means access is disabled.
pagination Object

Pagination information for the response.

▶ SHOW VALUES
- current_page Integer
  
  Current page number.
- per_page Integer
  
  Number of users per page.
- total_pages Integer
  
  Total number of pages available.
- total_count Integer
  
  Total number of users in the organization.

Update user access

PUT /user/v2/update-access

Update user access by modifying their RBAC role or product access levels. You must provide the user’s email address and at least one of the following: RBAC role or product access level.

Request body

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X PUT "https://api.browserstack.com/user/v2/update-access" \
-H "Content-Type: application/json" \
-d '{
    "email": "multiadmin@bsstag.com",
    "rbacRole": "User",
    "productAccess": "automate:Member"
}'

email^* string

Email address of the user to update.
rbacRole (Optional) string

RBAC role to assign. Possible values are Admin, User, or Viewer. Either rbacRole or productAccess must be provided. You can also pass a custom role name as the value.

productAccess (Optional) string

Product access level in the format product_name:access_level. For example, automate:Member or percy:Guest. Either rbacRole or productAccess must be provided.

Possible value	Description
`accessibility_design_toolkit`	Provide product access to Accessibility Design Toolkit for accessibility design checks.
`accessibility_testing`	Provide product access to Accessibility Testing for accessibility checks on your websites.
`app_accessibility_testing`	Provide product access to App Accessibility Testing for accessibility checks on mobile apps.
`app_automate`	Provide product access to App Automate for automated testing of your mobile apps.
`app_live_testing`	Provide product access to App Live for manual testing of your mobile apps.
`app_percy`	Provide product access to App Percy for visual testing of your mobile apps.
`automate`	Provide product access to Automate for automated testing of your websites.
`automate_turboscale`	Provide product access to Automate Turboscale for scalable automated testing.
`bug_capture`	Provide product access to Bug Capture for capturing and reporting bugs.
`central_scanner`	Provide product access to Central Scanner for centralized scanning of your applications.
`live_testing`	Provide product access to Live for manual testing of your websites.
`low_code_automation`	Provide product access to Low Code Automation for simplified automation workflows.
`percy`	Provide product access to Percy for visual testing of your websites.
`requestly`	Provide product access to Requestly for intercepting and modifying network requests.
`screenshot`	Provide product access to Screenshot for capturing screenshots of your websites.
`test_management`	Provide product access to Test Management for managing your test cases and plans.
`test_observability`	Provide product access to Test Reporting & Analytics for monitoring and analyzing test executions.
`testing_toolkit`	Provide product access to Testing Toolkit for enhanced testing capabilities.
`browser_testing`	Provide product access to Live and Automate.
`mobile_app_testing`	Provide product access to App Live and App Automate for manual and automated testing of your mobile apps.

Response `200` `application/json`

Response

{
    "success": true,
    "message": "Product access and RBAC role updated successfully for multiadmin@bsstag.com"
}

success Boolean

Indicates whether the user access update was successful.
message String

Success message confirming the product access and RBAC role update for the specified user email.

Get team details

GET /user/v2/team-detail

Retrieve detailed information about all teams in your organization, including allocated licenses, parallels, screenshots, and team members.

Request

Request (Without team name)

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/user/v2/team-detail"
-H "Content-Type: application/json" \

Request (With team name)

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/user/v2/team-detail?teamName=Automation%20Team&page=1"
-H "Content-Type: application/json" \

page (Optional) integer

The page number for pagination. Use this to retrieve a specific page of results.
teamName (Optional) string

Filter results by specific user team name. You can provide multiple team names separated by commas. If you do not specify a team name, the response returns details for all teams.

Response attributes `200` `application/json`

Response (Without team name)

{
  "count": 3,
  "team_details": [
    {
      "name": "Automation Team",
      "created_at": "2026-03-18T09:17:48.000Z",
      "licenses_allocated": {
        "live": {
          "val": "Unlimited",
          "type": "Org"
        },
        "app_live": {
          "val": 10,
          "type": "Team"
        },
        "app_low_code_automation": {
          "val": "Unlimited",
          "type": "Org"
        },
        "accessibility_design_toolkit": {
          "val": "Unlimited",
          "type": "Org"
        },
        "testing_toolkit": {
          "val": "Unlimited",
          "type": "Org"
        },
        "requestly": {
          "val": "Unlimited",
          "type": "Org"
        },
        "bug_capture": {
          "val": 3,
          "type": "Org"
        },
        "app_accessibility_testing": {
          "val": 10,
          "type": "Team"
        },
        "low_code_automation": {
          "val": "Unlimited",
          "type": "Org"
        },
        "test_management": {
          "val": 5,
          "type": "Org"
        },
        "accessibility_testing": {
          "val": 10,
          "type": "Team"
        }
      },
      "parallels_allocated": {
        "automate": {
          "val": 5,
          "type": "Org"
        },
        "app_automate": {
          "val": 0,
          "type": "Org"
        }
      },
      "screenshots_allocated": {
        "percy": {
          "val": "NA",
          "type": "Org"
        },
        "app_percy": {
          "val": "NA",
          "type": "Org"
        }
      },
      "user_count": 0,
      "user_details": []
    },
    {
      "name": "DevOps Team",
      "created_at": "2026-03-18T09:18:12.000Z",
      "licenses_allocated": {
        "live": {
          "val": "Unlimited",
          "type": "Org"
        },
        "app_live": {
          "val": 5,
          "type": "Team"
        },
        "app_low_code_automation": {
          "val": "Unlimited",
          "type": "Org"
        },
        "accessibility_design_toolkit": {
          "val": "Unlimited",
          "type": "Org"
        },
        "testing_toolkit": {
          "val": 10,
          "type": "Team"
        },
        "requestly": {
          "val": "Unlimited",
          "type": "Org"
        },
        "bug_capture": {
          "val": 3,
          "type": "Org"
        },
        "app_accessibility_testing": {
          "val": 10,
          "type": "Team"
        },
        "low_code_automation": {
          "val": "Unlimited",
          "type": "Org"
        },
        "test_management": {
          "val": 5,
          "type": "Org"
        },
        "accessibility_testing": {
          "val": "Unlimited",
          "type": "Org"
        }
      },
      "parallels_allocated": {
        "automate": {
          "val": 5,
          "type": "Org"
        },
        "app_automate": {
          "val": 5,
          "type": "Team"
        }
      },
      "screenshots_allocated": {
        "percy": {
          "val": 5000,
          "type": "Team"
        },
        "app_percy": {
          "val": "NA",
          "type": "Org"
        }
      },
      "user_count": 0,
      "user_details": []
    },
    {
      "name": "Manual Testing Team",
      "created_at": "2026-03-18T09:17:58.000Z",
      "licenses_allocated": {
        "live": {
          "val": "Unlimited",
          "type": "Org"
        },
        "app_live": {
          "val": 10,
          "type": "Team"
        },
        "app_low_code_automation": {
          "val": "Unlimited",
          "type": "Org"
        },
        "accessibility_design_toolkit": {
          "val": "Unlimited",
          "type": "Org"
        },
        "testing_toolkit": {
          "val": "Unlimited",
          "type": "Org"
        },
        "requestly": {
          "val": "Unlimited",
          "type": "Org"
        },
        "bug_capture": {
          "val": 3,
          "type": "Org"
        },
        "app_accessibility_testing": {
          "val": 10,
          "type": "Team"
        },
        "low_code_automation": {
          "val": "Unlimited",
          "type": "Org"
        },
        "test_management": {
          "val": 5,
          "type": "Org"
        },
        "accessibility_testing": {
          "val": 10,
          "type": "Team"
        }
      },
      "parallels_allocated": {
        "automate": {
          "val": 5,
          "type": "Org"
        },
        "app_automate": {
          "val": 0,
          "type": "Org"
        }
      },
      "screenshots_allocated": {
        "percy": {
          "val": "NA",
          "type": "Org"
        },
        "app_percy": {
          "val": "NA",
          "type": "Org"
        }
      },
      "user_count": 0,
      "user_details": []
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 15,
    "total_pages": 1,
    "total_count": 3
  }
}

Response (With team name)

{
  "name": "Automation Team",
  "created_at": "2026-03-18T09:17:48.000Z",
  "licenses_allocated": {
    "live": {
      "val": "Unlimited",
      "type": "Org"
    },
    "app_live": {
      "val": 10,
      "type": "Team"
    },
    "app_low_code_automation": {
      "val": "Unlimited",
      "type": "Org"
    },
    "accessibility_design_toolkit": {
      "val": "Unlimited",
      "type": "Org"
    },
    "testing_toolkit": {
      "val": "Unlimited",
      "type": "Org"
    },
    "requestly": {
      "val": "Unlimited",
      "type": "Org"
    },
    "bug_capture": {
      "val": 3,
      "type": "Org"
    },
    "app_accessibility_testing": {
      "val": 10,
      "type": "Team"
    },
    "low_code_automation": {
      "val": "Unlimited",
      "type": "Org"
    },
    "test_management": {
      "val": 5,
      "type": "Org"
    },
    "accessibility_testing": {
      "val": 10,
      "type": "Team"
    }
  },
  "parallels_allocated": {
    "automate": {
      "val": 5,
      "type": "Org"
    },
    "app_automate": {
      "val": 0,
      "type": "Org"
    }
  },
  "screenshots_allocated": {
    "percy": {
      "val": "NA",
      "type": "Org"
    },
    "app_percy": {
      "val": "NA",
      "type": "Org"
    }
  },
  "user_count": 0,
  "user_details": []
}

Did this page help you?

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

User Management API V2

Get user details

Request parameters

email (Optional) string

page (Optional) integer

Response attributes 200 application/json

count Integer

user_details Array

id Integer

username String

full_name String

email String

role String

organization_name String

accessType Object

rbacRole String

status String

product_access Object

pagination Object

current_page Integer

per_page Integer

total_pages Integer

total_count Integer

Update user access

Request body

email* string

rbacRole (Optional) string

productAccess (Optional) string

Response 200 application/json

success Boolean

message String

Get team details

Request

page (Optional) integer

teamName (Optional) string

Response attributes 200 application/json

We're sorry to hear that. Please share your feedback so we can do better

We're continuously improving our docs. We'd love to know what you liked

Response attributes `200` `application/json`

email^* string

Response `200` `application/json`

Response attributes `200` `application/json`