Query Password Policies

Query Password Policies
Query password policies

Filters on policyIds and policyNames combine with logical AND across dimensions; multiple values within a field are OR. Returns an empty list if no policy matches all active filters.

Request
URI
POST
https://{api_host}/suite-api/api/fleet-management/password-policies/query
COPY
Query Parameters
integer
page
Optional
Constraints: default: 0

Page index (0-based)

integer
pageSize
Optional
Constraints: minimum: 1 maximum: 10000 default: 1000

Page size

string
sortBy
Optional
Constraints: default: updatedAt

Sort field

Enumeration: name, createdAt, updatedAt
string
sortOrder
Optional
Constraints: default: ASCENDING

Sort direction

Enumeration: ASCENDING, DESCENDING
Request Body

Optional query filters (omit body for unfiltered query)

PasswordPolicyQuery of type(s) application/json
Optional 
"{\n  \"policyIds\" : [ \"033a28ca-50be-4aa1-ada0-d7558b21c75a\" ],\n  \"policyNames\" : [ \"Fleet Example Policy\" ]\n}"
boolean
fleet
Optional

When true, returns only fleet-wide policies. When false, returns only non-fleet policies. When omitted, all policies are returned regardless of fleet designation.

array of string
policyIds
Optional
Constraints: minItems: 0 maxItems: 100

List of policy ids to be queried

array of string
policyNames
Optional
Constraints: minItems: 0 maxItems: 100

List of policy names to be queried

Authentication
This operation uses the following authentication methods.
Responses
200

Paged policies

Returns PasswordPolicies of type(s) application/json 
"{\n  \"pageInfo\" : {\n    \"totalCount\" : 1,\n    \"page\" : 0,\n    \"pageSize\" : 50,\n    \"sortBy\" : \"updatedAt\",\n    \"sortOrder\" : \"ASCENDING\"\n  },\n  \"policies\" : [ {\n    \"id\" : \"033a28ca-50be-4aa1-ada0-d7558b21c75a\",\n    \"name\" : \"Fleet Example Policy\",\n    \"description\" : \"Example fleet password policy for API documentation\",\n    \"complexityConstraints\" : {\n      \"minLength\" : 12,\n      \"minLowercase\" : 1,\n      \"minUppercase\" : 1,\n      \"minNumeric\" : 1,\n      \"minSpecial\" : 1,\n      \"passwordHistory\" : 3\n    },\n    \"expirationConstraints\" : {\n      \"maxDays\" : 90,\n      \"warnDays\" : 7\n    },\n    \"lockoutConstraints\" : {\n      \"lockoutMaxAuthFailures\" : 3,\n      \"lockoutEvaluationPeriod\" : 900,\n      \"lockoutPeriod\" : 900\n    },\n    \"createdAt\" : 1741630060000,\n    \"updatedAt\" : 1741716460000\n  } ]\n}"
array of object
links
Optional

Collection of links

object
pageInfo
Optional

Represents page information for a paged result

array of object
policies
Optional

Matching policies for the current page (union of query filters, deduplicated)


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/fleet-management/password-policies/query
On This Page
Fleet Password Policy Management Operations
POST
Create Password Policy
PUT
Update Password Policy
POST
Export Compliance
POST
Query Components
POST
Query Component Groups
POST
Submit Policy Task
POST
Query Component Group Tasks
GET
Get Component Group Task
POST
Export Password Policies
POST
Query Password Policies
DELETE
Delete Password Policy
GET
Get Password Policy