Query Api Clients

Query Api Clients
Query API Clients with search filters and pagination

Queries API Clients in an SSO Realm with search filters and pagination support. Results can be sorted by expiration date, creation date, last used date, or access token TTL.

Request
URI
POST
https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/api-clients/query
COPY
Path Parameters
string
ssoRealmId
Required

SSO Realm identifier

Query Parameters
integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 50

Expected number of entries per page

Request Body

API Client search parameters

ClientTokenQuery of type(s) application/json
Required 
"{\n  \"searchTerms\" : {\n    \"allOf\" : [ {\n      \"field\" : \"CLIENT_ID\",\n      \"terms\" : [ \"client\" ],\n      \"operator\" : \"LIKE\"\n    }, {\n      \"field\" : \"CLIENT_NAME\",\n      \"terms\" : [ \"Automation\" ],\n      \"operator\" : \"LIKE\"\n    } ],\n    \"anyOf\" : [ ]\n  }\n}"
object
filters
Optional

Field values that can be used to filter API client and API token data

object
searchTerms
Optional

Groupings of search conditions to match in API client and API token lists

Authentication
This operation uses the following authentication methods.
Responses
200

List of API Clients with pagination data

Returns ApiClients of type(s) application/json 
"{\n  \"pageInfo\" : {\n    \"totalCount\" : 2,\n    \"page\" : 0,\n    \"pageSize\" : 10\n  },\n  \"apiClients\" : [ {\n    \"clientId\" : \"api-client-id\",\n    \"clientUuid\" : \"77ca0ca8-a504-4969-aeed-4ac453c1ef61\",\n    \"clientName\" : \"Automation API Client\",\n    \"clientDescription\" : \"API Client for automation purposes\",\n    \"roles\" : [ {\n      \"roleName\" : \"vcf_administrator\",\n      \"roleDisplayName\" : \"VCF Administrator\",\n      \"roleScope\" : {\n        \"resources\" : [ ],\n        \"scopeType\" : \"SSO_REALM\",\n        \"ssoName\" : \"EMEA\"\n      },\n      \"expiresAt\" : 1750526688158\n    } ]\n  }, {\n    \"clientId\" : \"api-client-id-2\",\n    \"clientUuid\" : \"77ca0ca8-a504-4969-aeed-4ac453c1ef61\",\n    \"clientName\" : \"Automation API Client 2\",\n    \"clientDescription\" : \"API Client for automation purposes\",\n    \"roles\" : [ {\n      \"roleName\" : \"vcf_administrator\",\n      \"roleDisplayName\" : \"VCF Administrator\",\n      \"roleScope\" : {\n        \"resources\" : [ ],\n        \"scopeType\" : \"SSO_REALM\",\n        \"ssoName\" : \"EMEA\"\n      },\n      \"expiresAt\" : 1750526688158\n    } ]\n  } ]\n}"
array of object
apiClients
Required

List of API clients in this page

array of object
links
Optional

Collection of links

object
pageInfo
Optional

Represents page information for a paged result


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/api-clients/query
On This Page
Iam Apis Operations
GET
Get Eligible Components
DELETE
Delete Iam Component Auth Source
POST
Create Iam Component Auth Source
POST
Get Iam Component Auth Sources
GET
Get Component Roles
POST
Provision Component Role
PUT
Update Component Role
GET
Get Component Role Summaries
DELETE
Delete Component Role
GET
Get Component Role
POST
Trigger Drift Check
POST
Retry Apply For Role
GET
Get Component Role Definitions
POST
Configure IDP
PUT
Update IDP Configuration
DELETE
Delete IDP Configuration
GET
Get IDP Configuration
GET
Get Scim Sync Client Info
POST
Generate Scim Sync Client
GET
Get Ldap Directories
POST
Lookup Ldap Groups
POST
Execute Ldap Sync
GET
Get Ldap Sync Logs
GET
Get Ldap Sync Log By Id
GET
Get Ldap Sync Profile
PUT
Update Ldap Sync Profile
POST
Lookup Ldap Users
GET
Get VCF Roles Paginated
POST
Create Role
PUT
Update Role Definition
DELETE
Delete Role
GET
Get Role
POST
Validate Saml Metadata
GET
Get Iam Settings
PUT
Update Iam Settings
GET
Get Sso Realm List
POST
Create Sso Realm
DELETE
Delete Sso Realm
GET
Get Sso Realm
PATCH
Update Api Client
POST
Create Api Client
POST
Query Api Clients
DELETE
Delete Api Client
GET
Get Api Client
PATCH
Update Api Token
POST
Generate Api Token
POST
Query Api Tokens
DELETE
Delete Api Token
GET
Get Api Token
POST
Re Generate Api Token
GET
List Emergency Clients
POST
Create Emergency Client
DELETE
Delete Emergency Client
GET
Get Emergency Client
POST
Regenerate Emergency Client
POST
Get Groups List
POST
Get Group Members List
GET
List O Auth Apps
POST
Create O Auth App
PUT
Update O Auth App
DELETE
Delete O Auth App
GET
Get O Auth App
POST
Rotate O Auth App Secret
DELETE
Delete Role Assignments
GET
Get Role Assignment
PUT
Update Role Assignment
POST
Get Users List
GET
Get Iam Task Details
GET
Get Eligible Vidbs
PATCH
Update Vidb Metadata