Files
api-specs/idn/beta/paths/identity-group-identities.yaml
GitHub Action Bot 1013fe10a3 Automated commit 'DEVREL-1270 (#1473)
* 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
2023-10-31 14:33:08 +00:00

48 lines
1.4 KiB
YAML

get:
operationId: getIdentities
summary: Identities in an Identity Group
tags:
- IAI Identity Groups
description: >-
The Identities in an Identity Group API returns a list of identities associated with an identity group based on the group ID.
parameters:
- in: path
name: identityGroupId
schema:
type: string
required: true
description: The identity group id
example: 'ff8081814d2a8036014d701f3fbf53fa'
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/count.yaml'
- in: query
name: filters
schema:
type: string
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:
**attributes**: *eq, sw*
example: attributes sw "r"
responses:
'200':
description: The identities for an identity group
content:
application/json:
schema:
type: array
items:
$ref: '../schemas/IdentityRefWithAttributes.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
security:
- bearerAuth : []