mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
1013fe10a3
* Fixed sorter/filter descriptions for several endpoints. Moved beta collection tags into alphabetic order. * Fixed the remaining sorter/filter linter errors * Removed default value from sorter params as they are not valid.' by github action: 6708027043
100 lines
2.6 KiB
YAML
100 lines
2.6 KiB
YAML
get:
|
|
operationId: listIdentities
|
|
tags:
|
|
- Identities
|
|
summary: List Identities
|
|
description: >-
|
|
This API returns a list of identities.
|
|
parameters:
|
|
- in: query
|
|
name: filters
|
|
schema:
|
|
type: string
|
|
required: false
|
|
description: >-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
|
|
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
|
|
**id**: *eq, in*
|
|
|
|
|
|
**name**: *eq, sw*
|
|
|
|
|
|
**alias**: *eq, sw*
|
|
|
|
|
|
**firstname**: *eq, sw*
|
|
|
|
|
|
**lastname**: *eq, sw*
|
|
|
|
|
|
**email**: *eq, sw*
|
|
|
|
|
|
**cloudStatus**: *eq*
|
|
|
|
|
|
**processingState**: *eq*
|
|
|
|
|
|
**correlated**: *eq*
|
|
|
|
|
|
**protected**: *eq*
|
|
example: id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false
|
|
- in: query
|
|
name: sorters
|
|
schema:
|
|
type: string
|
|
format: comma-separated
|
|
required: false
|
|
description: >-
|
|
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
|
|
|
|
|
|
Sorting is supported for the following fields: **name, alias, cloudStatus**
|
|
example: name,-cloudStatus
|
|
- in: query
|
|
name: defaultFilter
|
|
schema:
|
|
type: string
|
|
enum: [CORRELATED_ONLY, NONE]
|
|
default: CORRELATED_ONLY
|
|
required: false
|
|
description: >-
|
|
Adds additional filter to filters query parameter.
|
|
|
|
|
|
CORRELATED_ONLY adds correlated=true and returns only identities that are correlated.
|
|
|
|
|
|
NONE does not add any and returns all identities that satisfy filters query parameter.
|
|
example: NONE
|
|
- $ref: "../../v3/parameters/count.yaml"
|
|
- $ref: "../../v3/parameters/limit.yaml"
|
|
- $ref: "../../v3/parameters/offset.yaml"
|
|
responses:
|
|
"200":
|
|
description: List of identities.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "../../beta/schemas/Identity.yaml"
|
|
"400":
|
|
$ref: "../../v3/responses/400.yaml"
|
|
"401":
|
|
$ref: "../../v3/responses/401.yaml"
|
|
"403":
|
|
$ref: "../../v3/responses/403.yaml"
|
|
"429":
|
|
$ref: "../../v3/responses/429.yaml"
|
|
"500":
|
|
$ref: "../../v3/responses/500.yaml"
|