{ "opencollection": "1.0.0", "info": { "name": "Bench AccountActivities AccountUsers API", "version": "1.0" }, "items": [ { "info": { "name": "AccountUsers", "type": "folder" }, "items": [ { "info": { "name": "Gets the users for the given account", "type": "http" }, "http": { "method": "GET", "url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The Account ID" }, { "name": "offset", "value": "", "type": "query", "description": "Offset for pagination" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results in this page" }, { "name": "group", "value": "", "type": "query", "description": "Optional parameter to filter results based on user groups" }, { "name": "ids", "value": "", "type": "query", "description": "(Optional) Filters the result to contain account users that match the ids passed in." }, { "name": "nameSearch", "value": "", "type": "query", "description": "(Optional) Searches for users by partial name match (minimum 3 characters)." } ] }, "docs": "
Permissions
Account: Read" }, { "info": { "name": "Gets the the specified user for the given account by ID", "type": "http" }, "http": { "method": "GET", "url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:id", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The Account ID" }, { "name": "id", "value": "", "type": "path", "description": "The User's ID" } ] }, "docs": "
Permissions
Account: Read" }, { "info": { "name": "Updates a user for the given account", "type": "http" }, "http": { "method": "PATCH", "url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:id", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The Account ID" }, { "name": "id", "value": "", "type": "path", "description": "Id of the user to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Name or Title can be null, but they cannot be empty/whitespace. If null the value will not be changed.
Permissions
Account: Write" }, { "info": { "name": "Deactivates a user from the given account", "type": "http" }, "http": { "method": "DELETE", "url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:id", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The Account ID" }, { "name": "id", "value": "", "type": "path", "description": "Id of the user to remove" } ] }, "docs": "Adminsitrators can only deactivate other users from the account and not themselves.
Permissions
Account: Write" }, { "info": { "name": "Modify user's permission group in the account.", "type": "http" }, "http": { "method": "PUT", "url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:id/membership", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The Account ID" }, { "name": "id", "value": "", "type": "path", "description": "ID of the user to modify" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Groups in the account can be fetched from the api/v{version}/accounts/{accountId}/groups endpoint.
Permissions
Account: Write" }, { "info": { "name": "Resets a user's authentication method and sends a new invitation email.\nThis can be used to switch a user from SSO to username/password authentication.\nNote: users can be on multiple accounts in an organization. This resets the auth method in all accounts within\nthe organization.", "type": "http" }, "http": { "method": "POST", "url": "https://bench.gobridgit.com/rp/api/v1/accounts/:accountId/users/:userId/reset-auth-method", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The account that is currently calling this method." }, { "name": "userId", "value": "", "type": "path", "description": "The ID of the account user." } ] }, "docs": "
Permissions
Account: Write" } ] } ], "bundled": true }