Manage service accounts
Get service account
List all service accounts.
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/user/service-accounts"
No parameter required.
Response attributes 200 application/json
Response
[
{
"identifier": "AutomateTests",
"username": "automatetests1EqSeL",
"authkey": "5LYN2pByHzFKqy5FtrNw",
"teamName": "Acme Inc.",
"mainGroup": true
},
{
"identifier": "CircleCIss",
"username": "circleci8gqa46",
"authkey": "7EqzLymbYio4kxzCfw4J",
"teamName": "WebTesting",
"mainGroup": true
}
]
-
Array
▶ SHOW VALUESList of recent projects
-
identifier String
Service account identifier. Example ‘ci_testing’.
-
username String
Service account username. Example ‘citesting_OUDxHrb2Sz8’
-
authkey String
Service account authentication key. Example ‘xqz7ygA79xdX6qe’
-
teamName String
Name of the team or organization on BrowserStack. If the service account has been created for organization then teamName will correspond to the Organization name on BrowserStack.
-
mainGroup Boolean
Indicates whether service accounts belong to organization or team.
Values Description trueIf service account has been created for organization and not an individual team. falseIf service account has been created for a team and not the organization.
-
Create service account
Create a new service account on BrowserStack. You need to pass an identifier and there will be a username returned for service account on successful creation. By default service account will be created for Organization. If you want to create the service account to be used by an individual team, then you can pass teamName param.
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api.browserstack.com/user/service-accounts?identifier=ci_testing"
-
identifier* String
Identifier for a service account.
-
teamName String
If you want to create a service account for a team, you need to specify the team name.
Response attributes 200 application/json
Response
{
"identifier": "ci_testing",
"username": "citesting_OUDxHrb2",
"authkey": "xqz7ygA79xdX6qeV",
"teamName": "Acme Inc.",
"mainGroup": true
}
-
identifier String
Service account identifier. Example ‘ci_testing’.
-
username String
Service account username. Example ‘citesting_OUDxHrb2Sz8’
-
authkey String
Service account authentication key. Example ‘xqz7ygA79xdX6qe’
-
teamName String
Name of the team or organization on BrowserStack. If the service account has been created for organization then teamName will correspond to the Organization name on BrowserStack.
-
mainGroup Boolean
Indicates whether service accounts belong to organization or team.
Values Description trueIf service account has been created for organization and not an individual team. falseIf service account has been created for a team and not the organization.
Delete service account
Delete a service account by passing username of the service account.
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X DELETE "https://api.browserstack.com/user/service-accounts?username=citesting_OUDxHrb2"
-
username* String
Username of the service account. Example
citesting_OUDxHrb2Sz8
Response attributes 200 application/json
Response
{
"message": "service account deleted successfully."
}
-
message String
Service account deleted successfully.
Update service account
Update an existing service account. You can update the identifier of any service account.
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X PATCH "https://api.browserstack.com/user/service-accounts?username=citesting_OUDxHrb2&identifier=ci_testing_new"
-
username* String
Username of the service account.
-
identifier* String
New identifier you want to set for the given service account.
-
teamName String
If you want to update the team to which service account belongs, you can pass the team name as well.
Response attributes 200 application/json
Response
{
"identifier": "ci_testing_new",
"username": "citesting_OUDxHrb2",
"authkey": "xqz7ygA79xdX6qeV",
"teamName": "Acme Inc.",
"mainGroup": true
}
-
identifier String
Service account identifier. Example ‘ci_testing’.
-
username String
Service account username. Example ‘citesting_OUDxHrb2Sz8’
-
authkey String
Service account authentication key. Example ‘xqz7ygA79xdX6qe’
-
teamName String
Name of the team or organization on BrowserStack. If the service account has been created for organization then teamName will correspond to the Organization name on BrowserStack.
-
mainGroup Boolean
Indicates whether service accounts belong to organization or team.
Values Description trueIf service account has been created for organization and not an individual team. falseIf service account has been created for a team and not the organization.
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.