Deprecated
The content in this section of the guide has been deprecated and is compatible with earlier versions only.
Quick Navigation
- [deprecated] POST Imports/QueueImportFile
- [deprecated] POST SmartRules/FilterSingleAccount
- [deprecated] GET UserGroups/{name}
- [deprecated] DELETE UserGroups/{name}
- [deprecated] GET Workgroups/{name}
Imports
[deprecated] POST Imports/QueueImportFile
This API has been deprecated and is available for backwards compatibility only. Use POST Imports with Base64FileContents instead.
Purpose
Queues a Password Safe XML import using multi-part form-data content.
Required Permissions
Scan Management (Read/Write).
Request Body
Content-Type: multipart/form-data
{ Content-type: application/json { WorkgroupID: int, FileName: string } application/octet-stream { <string-encoded byte array representing the file> } }
Request Body Details
- WorkgroupID: ID of the Workgroup to import the assets into.
- FileName: Filename (including extension) of the import file.
Response Body
Content-Type: application/json
{ ImportID: int }
Response Codes
- 200 – Request successful. Import ID in the response body.
- 400 – The import file was not found in the body of the request, or a request body validation error has occurred.
Smart Rules
[deprecated] POST SmartRules/FilterSingleAccount
This API has been deprecated and is available for backwards compatibility only. Use QuickRules instead.
Purpose
Specialized action for creating a Managed Account-type Smart Rule for filtering a single Managed Account by System Name and Account Name.
Required Permissions
Smart Rule Management - Managed Account (Read/Write).
Request Body
Content-type: application/json
{ AccountID: int, Title: string }
Request Body Details
- AccountID: (required) ID of the managed account you want to filter by parent System Name and Account Name.
- Title: (optional) The title/name of the new Smart Rule. If omitted, a unique title is auto-generated.
Response Body
Content-Type: application/json
{ SmartRuleID: int, OrganizationID : string, // can be null Title: string, Description: string, Category: string, Status: int, LastProcessedDate: datetime, IsReadOnly: bool, RuleType: string }
Response Codes
201 – Request successful. Smart Rule in the response body.
User Groups
[deprecated] GET UserGroups/{name}
This API has been deprecated and is available for backwards compatibility only. Use GET UserGroups?name={name} instead.
Purpose
Returns a user group by name.
Required Permissions
User Accounts Management (Read).
URL Parameters
name: Name of the user group.
Request Body
None.
Response Body
Content-Type: application/json
{ GroupID : int, Name : string, DistinguishedName : string, GroupType : string, AccountAttribute : string, MembershipAttribute : string, IsActive : bool }
Response Codes
200 – Request successful. User group in the response body.
[deprecated] DELETE UserGroups/{name}
This API has been deprecated and is available for backwards compatibility only. Use DELETE UserGroups?name={name} instead.
Purpose
Deletes a user group by name.
Required Permissions
User Accounts Management (Read/Write).
URL Parameters
name: Name of the user group.
Request Body
None.
Response Body
None.
Response Codes
200 – Request successful.
Workgroups
[deprecated] GET Workgroups/{name}
This API has been deprecated and is available for backwards compatibility only. Use GET Workgroups?name={name} instead.
Purpose
Returns a Workgroup by name.
Required Permissions
Current user has permission to the Workgroup Organization. Asset Management (Read) or Scan Management (Read/Write).
Query Parameters
name: Name of the Workgroup.
Request Body
None.
Response Body
Content-Type: application/json
{ OrganizationID : string, ID : int, Name : string }
Response Codes
200 – Request successful. Workgroups in the response body.