Search a Profile API

Use this API to search profile.

POST/fim/v3/profiles/search

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

attributes

Mandatory

String

The list of comma-separated attributes that you

want to include in the response. By default, all attributes will be returned in the result.

filter

Mandatory

String

Filter the Profile rules by providing a query

using Qualys syntax. Refer to the “How to Search” topic in the

Online Help for assistance with creating your query.

For example - action: 'Content'

pageNumber

Mandatory

 

The page number to be returned. The number

starts from zero.

pageSize

Mandatory

String

The number of records per page to be included in

the response. Default is 10.

sort Mandatory

String

Sort the results using Profile rule attributes.

SampleSample

API Request

curl -X POST https://<QualysBaseURL>/fim/v3/profiles/search 
-H 'authorization: Bearer <token>' 
-H 'content-type: application/json' 
-d @request.json

Contents of request.json:

{
        "attributes": "string",
        "filter": "string",
        "pageNumber": "number",
        "pageSize": "number",
        "sort": "string",
}

Response

{
        "updatedBy": {
                "date": 1582023188082,
                "user": {
                        "name": "John Doe",
                        "id": "x37x1x6x-x023-x948-80xx-2xx6022x3436"
                }
        },
        "assetTagIds": [],
        "assetIds": [],
        "type": "LINUX",
        "version": "1.0",
        "syncFromId": "00000000-0000-0001-0000-000000000001",
        "deletedBy": null,
        "deleted": false,
        "importRegistryRules": false,
        "registryProfile": false,
        "createdBy": {
                "date": 1581935157993,
                "user": {
                        "name": "John Doe",
                        "id": "x37x1x6x-x023-x948-80xx-2xx6022x3436"
                }
        },
        "name": "Linux testing FIM-3387 ",
        "customerId": "x5x0514x-x211-x1x4-809x-x3x2xx667xxx",
        "id": "x444920x-81xx-4xx6-x018-x44b0xx2xx22",
        "category": {
                "name": "PCI",
                "id": "2xxx5022-2xxx-11x7-93xx-92361f002671"
        },
        "syncType": "NOT_APPLICABLE",
        "status": "DEACTIVATED"
}