Files
api-specs/idn/v3/paths/account-activity-list.yaml

92 lines
2.8 KiB
YAML

get:
operationId: listAccountActivities
tags:
- Account Activities
summary: List Account Activities
description: >-
This gets a collection of account activities that satisfy the given query
parameters.
parameters:
- in: query
name: requested-for
schema:
type: string
description: >-
The identity that the activity was requested for. *me* indicates the
current user. Mutually exclusive with *regarding-identity*.
required: false
example: 2c91808568c529c60168cca6f90c1313
- in: query
name: requested-by
schema:
type: string
description: >-
The identity that requested the activity. *me* indicates the current
user. Mutually exclusive with *regarding-identity*.
required: false
example: 2c91808568c529c60168cca6f90c1313
- in: query
name: regarding-identity
schema:
type: string
description: >-
The specified identity will be either the requester or target of the
account activity. *me* indicates the current user. Mutually exclusive
with *requested-for* and *requested-by*.
required: false
example: 2c91808568c529c60168cca6f90c1313
- $ref: "../parameters/limit.yaml"
- $ref: "../parameters/offset.yaml"
- $ref: "../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:
**type**: *eq, in, ge, gt, le, lt, ne, isnull, sw*
**created**: *gt, lt, ge, le, eq, in, ne, isnull, sw*
**modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw*
example: type eq "Identity Refresh"
required: false
- in: query
name: sorters
schema:
type: string
format: comma-separated
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: **type, created, modified**
example: created
required: false
responses:
"200":
description: List of account activities
content:
application/json:
schema:
type: array
items:
$ref: "../schemas/AccountActivity.yaml"
"400":
$ref: "../responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"