{ "opencollection": "1.0.0", "info": { "name": "Secret Server Rest Activations Users API", "version": "11.7.2" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Get User", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/:id", "params": [ { "name": "includeInactive", "value": "", "type": "query", "description": "Whether to include inactive users in the results" }, { "name": "id", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Get a single user by ID" }, { "info": { "name": "Update User", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a single user by ID" }, { "info": { "name": "Update included properties for user by Id", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update included properties for user by Id" }, { "info": { "name": "Delete User", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Delete a user by ID" }, { "info": { "name": "Get User Owner", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/:id/owners/:ownerId", "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" }, { "name": "ownerId", "value": "", "type": "path", "description": "Owner ID" } ] }, "docs": "Get a single owner for a user" }, { "info": { "name": "Remove User Owner", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/users/:id/owners/:ownerId", "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" }, { "name": "ownerId", "value": "", "type": "path", "description": "Owner ID is the unique sequence for this specific owner. This is returned as ID on UserOwnerModel" } ] }, "docs": "Remove an owner from a single user" }, { "info": { "name": "Gets roles for user", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/:id/roles", "params": [ { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" }, { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Gets roles for user" }, { "info": { "name": "Add roles to existing user", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/:id/roles", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add roles to existing user" }, { "info": { "name": "Update all roles on user", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/users/:id/roles", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update all roles on user" }, { "info": { "name": "Remove roles from existing user", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/users/:id/roles", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove roles from existing user" }, { "info": { "name": "Get User Groups", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/:id/groups", "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get the groups for a user by ID" }, { "info": { "name": "Add groups to existing user", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/:id/groups", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add groups to existing user" }, { "info": { "name": "Update all groups on user", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/users/:id/groups", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update all groups on user" }, { "info": { "name": "Remove groups from existing user", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/users/:id/groups", "params": [ { "name": "groupIds", "value": "", "type": "query", "description": "groupIds" }, { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Remove groups from existing user" }, { "info": { "name": "Search Users", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users", "params": [ { "name": "filter.domainId", "value": "", "type": "query", "description": "If not null, filters users by Active Directory domain." }, { "name": "filter.excludeInboxRuleIdSubscribers", "value": "", "type": "query", "description": "When set all subscribers not subscribed directly to this inbox notification rule will be excluded." }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Whether to include inactive users in the results." }, { "name": "filter.searchFields", "value": "", "type": "query", "description": "User fields to search." }, { "name": "filter.searchText", "value": "", "type": "query", "description": "The text to match in the username, display name, or email address." }, { "name": "filter.userIds", "value": "", "type": "query", "description": "User Ids to search." }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Search, filter, sort, and page users" }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user" }, { "info": { "name": "Current User Summary", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/current-summary" }, "docs": "Gets the current user summary" }, { "info": { "name": "Current User", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/current" }, "docs": "Gets the current user" }, { "info": { "name": "Lookup Users", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/lookup", "params": [ { "name": "filter.domainId", "value": "", "type": "query", "description": "If not null, filters users by Active Directory domain." }, { "name": "filter.excludeInboxRuleIdSubscribers", "value": "", "type": "query", "description": "When set all subscribers not subscribed directly to this inbox notification rule will be excluded." }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Whether to include inactive users in the results." }, { "name": "filter.searchFields", "value": "", "type": "query", "description": "User fields to search." }, { "name": "filter.searchText", "value": "", "type": "query", "description": "The text to match in the username, display name, or email address." }, { "name": "filter.userIds", "value": "", "type": "query", "description": "User Ids to search." }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Search, filter, sort, and page users, returning only user ID and name" }, { "info": { "name": "Get User Stub", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/stub" }, "docs": "Return the default values for a new user" }, { "info": { "name": "Get User by External Platform User ID", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/platform/:platformUserId", "params": [ { "name": "includeInactive", "value": "", "type": "query", "description": "Whether to include inactive users in the results" }, { "name": "platformUserId", "value": "", "type": "path", "description": "User Platform Guid" } ] }, "docs": "Get a single user by the External Platform User ID" }, { "info": { "name": "Get User Public Ssh Keys", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/public-ssh-keys", "params": [ { "name": "filter.includeExpired", "value": "", "type": "query", "description": "Whether to include expired user public ssh keys in the results" }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Whether to include inactive user public ssh keys in the results" }, { "name": "filter.searchText", "value": "", "type": "query", "description": "Search text" }, { "name": "filter.userId", "value": "", "type": "query", "description": "An optional ID for a specific user's public ssh keys" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get the public ssh keys for a user by ID" }, { "info": { "name": "Create a User Ssh Key", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/public-ssh-keys", "body": { "type": "json", "data": "{}" } }, "docs": "Create the public ssh keys for the current user" }, { "info": { "name": "Get User Owners", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/:id/owners", "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get the owners for a user by ID" }, { "info": { "name": "Add User Owner", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/:id/owners", "params": [ { "name": "id", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an owner to a single user" }, { "info": { "name": "Add and remove the owners on the user", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/users/:id/owners", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add and remove the owners on the user" }, { "info": { "name": "Get Domains", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/domains", "params": [ { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get Domains" }, { "info": { "name": "Get User Roles", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/:userId/roles-assigned", "params": [ { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" }, { "name": "userId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Get the roles for a user by ID" }, { "info": { "name": "User Audits", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/:userId/audit", "params": [ { "name": "isExporting", "value": "", "type": "query", "description": "isExporting" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" }, { "name": "userId", "value": "", "type": "path", "description": "userId" } ] }, "docs": "Get all of the audits for events that have occured for a specific user such as create user, edit user, change password, login success, login failed" }, { "info": { "name": "User Secret Activity", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/:userId/secret-activity", "params": [ { "name": "filter.endDate", "value": "", "type": "query", "description": "Include secrets accessed before this date. Can be null which will not filter by any end date and results in today basically." }, { "name": "filter.excludeInactiveSecrets", "value": "", "type": "query", "description": "Exclude any inactive secrets" }, { "name": "filter.excludeRotatedSecrets", "value": "", "type": "query", "description": "Exclude any secrets that rotate" }, { "name": "filter.folderId", "value": "", "type": "query", "description": "Only include secrets in a specific folder. Exclude or pass null to include all secrets" }, { "name": "filter.includeSubfolders", "value": "", "type": "query", "description": "Only used if a FolderId is included and when true it will also search subfolders. When false only secrets from the passed FolderId will be returned." }, { "name": "filter.startDate", "value": "", "type": "query", "description": "Include any Secrets access since this date" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" }, { "name": "userId", "value": "", "type": "path", "description": "userId" } ] }, "docs": "Get all Secret activity for a specific user" }, { "info": { "name": "User Audits by Action", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/action/audit", "params": [ { "name": "actions", "value": "", "type": "query", "description": "actions" }, { "name": "isExporting", "value": "", "type": "query", "description": "isExporting" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get all of the audits for users who performed the specified action" }, { "info": { "name": "User Teams", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/:userId/teams", "params": [ { "name": "filter.includeGroupMemberships", "value": "", "type": "query", "description": "Include Group Memberships" }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Include Inactive" }, { "name": "filter.searchTerm", "value": "", "type": "query", "description": "Search Term" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" }, { "name": "userId", "value": "", "type": "path", "description": "userId" } ] }, "docs": "Get all of the teams for a user" }, { "info": { "name": "Get Preference", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/preference", "params": [ { "name": "isLegacy", "value": "", "type": "query", "description": "Is Legacy" }, { "name": "settingCode", "value": "", "type": "query", "description": "Setting Code" }, { "name": "settingName", "value": "", "type": "query", "description": "Setting Name" } ] }, "docs": "Get a Preference for the current user" }, { "info": { "name": "Update Preference", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/preference", "body": { "type": "json", "data": "{}" } }, "docs": "Update a Preference for the current user" }, { "info": { "name": "User Sessions", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/users/sessions", "params": [ { "name": "isExporting", "value": "", "type": "query", "description": "isExporting" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get sessions for current user" }, { "info": { "name": "Deactivate SSH Key", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/users/public-ssh-keys/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Public SSH Key ID" } ] }, "docs": "Deactivate a User's Public SSH Key by specifying the key's ID" }, { "info": { "name": "Change User Password", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/change-password", "body": { "type": "json", "data": "{}" } }, "docs": "Change a user's password" }, { "info": { "name": "Verify the Current User Password", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/verify-password", "body": { "type": "json", "data": "{}" } }, "docs": "Verify the current user's password" }, { "info": { "name": "Reset 2FA", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/:userId/reset-two-factor", "params": [ { "name": "userId", "value": "", "type": "path", "description": "userId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reset 2FA for a specific user. After the reset they will need to update their 2FA on next login" }, { "info": { "name": "Reset a user password as an admin", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/:userId/password-reset", "params": [ { "name": "userId", "value": "", "type": "path", "description": "userId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The password reset command" }, { "info": { "name": "Delete a user's personally identifiable info", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/delete-pii/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Delete a user's personally identifiable info" }, { "info": { "name": "User Secret Activity Expiration", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/:userId/secret-activity/expire", "params": [ { "name": "userId", "value": "", "type": "path", "description": "userId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Expire all secrets access by a specific user and filter" }, { "info": { "name": "Lock Out", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/:userId/lock-out", "params": [ { "name": "userId", "value": "", "type": "path", "description": "userId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lock Out a specific user." }, { "info": { "name": "Terminate Current User Sessions", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/users/sessions/terminate", "body": { "type": "json", "data": "{}" } }, "docs": "Terminate sessions of the current user" }, { "info": { "name": "Update Users Doublelock Password", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/users/doublelock-password", "body": { "type": "json", "data": "{}" } }, "docs": "Update the doublelock password of a user" } ] } ], "bundled": true }