Files
developer.sailpoint.com/static/api-specs/idn/v3/paths/access-request-status.yaml
2022-10-13 20:19:10 +00:00

127 lines
3.8 KiB
YAML

get:
operationId: listAccessRequestStatus
tags:
- Access Requests
summary: Access Request Status
description: >-
The Access Request Status API returns a list of access request statuses
based on the specified query parameters.
Any token with any authority can request their own status. A token with
ORG_ADMIN authority is required to call this API to get a list of statuses
for other users.
parameters:
- in: query
name: requested-for
schema:
type: string
example: 2c9180877b2b6ea4017b2c545f971429
description: >-
Filter the results by the identity for which the requests were made.
*me* indicates the current user. Mutually exclusive with
*regarding-identity*.
required: false
- in: query
name: requested-by
schema:
type: string
example: 2c9180877b2b6ea4017b2c545f971429
description: >-
Filter the results by the identity that made the requests. *me*
indicates the current user. Mutually exclusive with
*regarding-identity*.
required: false
- in: query
name: regarding-identity
schema:
type: string
example: 2c9180877b2b6ea4017b2c545f971429
description: >-
Filter the results by the specified identity which is either the
requester or target of the requests. *me* indicates the current user.
Mutually exclusive with *requested-for* and *requested-by*.
required: false
- in: query
name: count
description: >-
If *true* it will populate the *X-Total-Count* response header with the
number of results that would be returned if *limit* and *offset* were
ignored.
required: false
schema:
type: boolean
default: false
example: false
- in: query
name: limit
description: Max number of results to return.
required: false
schema:
type: integer
format: int32
minimum: 0
maximum: 250
default: 250
example: 100
- in: query
name: offset
description: >-
Offset into the full result set. Usually specified with *limit* to
paginate through the results. Defaults to 0 if not specified.
required: false
schema:
type: integer
format: int32
minimum: 0
example: 10
- in: query
name: filters
schema:
type: string
example: accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"
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:
**accountActivityItemId**: *eq, in*
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: **created, modified,
accountActivityItemId**
example: created
required: false
responses:
"200":
description: List of requested item status.
content:
application/json:
schema:
type: array
items:
$ref: "../schemas/RequestedItemStatus.yaml"
"400":
$ref: "../../v3/responses/400.yaml"
"401":
$ref: "../responses/401.yaml"
"403":
$ref: "../responses/403.yaml"
"429":
$ref: "../responses/429.yaml"
"500":
$ref: "../responses/500.yaml"