{ "opencollection": "1.0.0", "info": { "name": "Assessment Service Assessment Groups users API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "users", "type": "folder" }, "items": [ { "info": { "name": "putUserRoleCredentialUser", "type": "http" }, "http": { "method": "PUT", "url": "https://client.synack.com/api/assessment/v2/user-role-credentials/:credentialUid/assigned-users/:userUid", "params": [ { "name": "credentialUid", "value": "", "type": "path", "description": "Unique identifier for an asset credential." }, { "name": "userUid", "value": "", "type": "path", "description": "Unique identifier for a user." } ] }, "docs": "Assign a user to a user-role credential. Credentials with sharing of \"one\" will return a 409 status code when a request is received to add further users. Credentials with sharing of \"all\" will return a 409 status code on any request to add users. There is not limit to the number of users that may be added for sharing of \"many\"." }, { "info": { "name": "deleteUserRoleCredentialUser", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.synack.com/api/assessment/v2/user-role-credentials/:credentialUid/assigned-users/:userUid", "params": [ { "name": "credentialUid", "value": "", "type": "path", "description": "Unique identifier for an asset credential." }, { "name": "userUid", "value": "", "type": "path", "description": "Unique identifier for a user." } ] }, "docs": "Remove a user from a user-role credential." }, { "info": { "name": "assignUserRoleCredentialsToUser", "type": "http" }, "http": { "method": "POST", "url": "https://client.synack.com/api/assessment/v2/user-role-credentials", "params": [ { "name": "organizationUid", "value": "", "type": "query", "description": "Unique identifier for an organization." }, { "name": "listingUid", "value": "", "type": "query", "description": "Unique identifier for a listing." }, { "name": "userUid", "value": "", "type": "query", "description": "Unique identifier for a user." } ] }, "docs": "Assign user role credentials to a user for mobile application or web application assets in a listing." }, { "info": { "name": "Get current user information", "type": "http" }, "http": { "method": "GET", "url": "https://client.synack.com/api/assessment/v1/users/whoami" }, "docs": "Retrieve information about the currently authenticated user" }, { "info": { "name": "Fetch users", "type": "http" }, "http": { "method": "GET", "url": "https://client.synack.com/api/assessment/v1/users" }, "docs": "Fetch all organization users (members & admins). Banned users will not be included. Requires admin privileges." }, { "info": { "name": "Create a new member/admin", "type": "http" }, "http": { "method": "POST", "url": "https://client.synack.com/api/assessment/v1/users", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new member/admin and grant it access to assessments (if any). Requires admin privileges." }, { "info": { "name": "Fetch user account", "type": "http" }, "http": { "method": "GET", "url": "https://client.synack.com/api/assessment/v1/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the user" } ] }, "docs": "Fetch information about a user account. Requires admin privileges." }, { "info": { "name": "Update user account status", "type": "http" }, "http": { "method": "PUT", "url": "https://client.synack.com/api/assessment/v1/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the user" }, { "name": "admin", "value": "", "type": "query", "description": "Flag to indicate whether to grant/remove admin privileges" }, { "name": "reactivate", "value": "", "type": "query", "description": "Flag to indicate whether to reactivate (unban) the user" } ] }, "docs": "Update existing user (reactivate and/or grant admin privileges). The user is automatically notified by e-mail upon account reactivation. Requires admin privileges." }, { "info": { "name": "Ban/delete user", "type": "http" }, "http": { "method": "DELETE", "url": "https://client.synack.com/api/assessment/v1/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the user" } ] }, "docs": "Ban/delete a user account. Requires admin privileges." } ] } ], "bundled": true }