{
"opencollection": "1.0.0",
"info": {
"name": "Bench AccountActivities ServiceAccounts API",
"version": "1.0"
},
"items": [
{
"info": {
"name": "ServiceAccounts",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets service accounts in the given account",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "ids",
"value": "",
"type": "query",
"description": "(Optional) Filters the result to contain accounts that match the ids passed in."
}
]
},
"docs": "
Permissions
Account: Read"
},
{
"info": {
"name": "Creates a service account in the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This endpoint will generate a unique login and password in the response.\n\nThere is no way to retrieve the password again after the account is created.\n\nThis is a limit of 10 service accounts on a single account.
Permissions
Account: Write"
},
{
"info": {
"name": "Updates a service account in the given account",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Service Account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "You must specify both \"name\" and \"group\" for this endpoint.
Permissions
Account: Write"
},
{
"info": {
"name": "Deactivates a service account in the given account",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts/:id",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Service Account ID"
}
]
},
"docs": "Deactivates the account preventing it from being able to log in and make API calls.
Permissions
Account: Write"
},
{
"info": {
"name": "Generates a new password for a service account in the given account",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/service-accounts/:id/reset-password",
"params": [
{
"name": "accountId",
"value": "",
"type": "path",
"description": "The Account ID"
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The Service Account ID"
}
]
},
"docs": "This endpoint will generate a new password in the response.\n\nThere is no way to retrieve the password again. A new password will need to be generated if you lose it.
Permissions
Account: Write"
}
]
}
],
"bundled": true
}