mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
96 lines
3.0 KiB
YAML
96 lines
3.0 KiB
YAML
get:
|
|
operationId: getCommonAccess
|
|
summary: Get a paginated list of common access
|
|
tags:
|
|
- IAI Common Access
|
|
description: >-
|
|
This endpoint returns the current common access for a customer. The returned items can be filtered and sorted.
|
|
Requires authorization scope of iai:access-modeling:read
|
|
parameters:
|
|
- $ref: '../../v3/parameters/offset.yaml'
|
|
- $ref: '../../v3/parameters/limit.yaml'
|
|
- $ref: '../../v3/parameters/count.yaml'
|
|
- in: query
|
|
name: filters
|
|
description: >-
|
|
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
|
|
|
|
|
|
Filtering is supported for the following fields and operators:
|
|
|
|
|
|
**status**: *eq* "CONFIRMED" or "DENIED"
|
|
**reviewedByUser** *eq* true or false
|
|
**access.id**: *eq* "id"
|
|
**access.type**: *eq* "ROLE" or "ACCESS_PROFILE"
|
|
**access.name**: *sw* "Administrator"
|
|
**access.description**: *sw* "admin"
|
|
required: false
|
|
style: form
|
|
explode: true
|
|
schema:
|
|
type: string
|
|
- 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://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
|
|
|
|
|
|
Sorting is supported for the following fields: **access.name,status**
|
|
|
|
|
|
By default the common access items are sorted by name, ascending.
|
|
responses:
|
|
'200':
|
|
description: Succeeded. Returns a list of common access for a customer.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '../schemas/CommonAccessResponse.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
post:
|
|
operationId: createCommonAccess
|
|
summary: Create common access items
|
|
tags:
|
|
- IAI Common Access
|
|
description: >-
|
|
This API is used to add roles/access profiles to the list of common access for a customer.
|
|
Requires authorization scope of iai:access-modeling:create
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/CommonAccessItemRequest.yaml'
|
|
responses:
|
|
'202':
|
|
description: Returns details of the common access classification request.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/CommonAccessItemResponse.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'
|
|
|
|
|