Skip to content

Commit da38b2d

Browse files
tyler-mairose-sptyler-mairose-sp
committed
Automated commit 'Merge pull request #1768 from sailpoint/cliu/idnarc-3604
IDNARC-3604 Add new access profiles api doc' by github action: 10639579141
1 parent 230eb8a commit da38b2d

21 files changed

+1491
-0
lines changed

‎idn/beta/paths/ears-source-app-access-profiles-bulk-remove.yaml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
post:
2+
operationId: deleteAccessProfilesFromSourceAppByBulk
3+
tags:
4+
- Apps
5+
summary: Bulk remove access profiles from the specified source app
6+
security:
7+
- UserContextAuth: [idn:app-roles:manage]
8+
description: >-
9+
This API returns the final list of access profiles for the specified source app after removing
10+
parameters:
11+
- name: id
12+
in: path
13+
description: ID of the source app
14+
required: true
15+
schema:
16+
type: string
17+
example: 2c91808a7813090a017814121e121518
18+
- $ref: '../../v3/parameters/limit.yaml'
19+
requestBody:
20+
required: true
21+
content:
22+
application/json:
23+
schema:
24+
type: array
25+
items:
26+
type: string
27+
description: List of access profile IDs for removal
28+
example: [
29+
"c9575abb5e3a4e3db82b2f989a738aa2",
30+
"c9dc28e148a24d65b3ccb5fb8ca5ddd9"
31+
]
32+
responses:
33+
'200':
34+
description: The final list of access profiles for the specified source app
35+
content:
36+
application/json:
37+
schema:
38+
type: array
39+
items:
40+
$ref: '../schemas/app/AccessProfileDetails.yaml'
41+
'400':
42+
$ref: '../../v3/responses/400.yaml'
43+
'401':
44+
$ref: '../../v3/responses/401.yaml'
45+
'403':
46+
$ref: '../../v3/responses/403.yaml'
47+
'429':
48+
$ref: '../../v3/responses/429.yaml'
49+
'500':
50+
$ref: '../../v3/responses/500.yaml'

‎idn/beta/paths/ears-source-app-access-profiles.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
get:
2+
operationId: listAccessProfilesForSourceApp
3+
tags:
4+
- Apps
5+
summary: List access profiles for the specified source app
6+
security:
7+
- UserContextAuth: [idn:app-roles:manage]
8+
description: >-
9+
This API returns the list of access profiles for the specified source app
10+
parameters:
11+
- name: id
12+
in: path
13+
description: ID of the source app
14+
required: true
15+
schema:
16+
type: string
17+
example: 2c91808a7813090a017814121e121518
18+
- $ref: '../../v3/parameters/limit.yaml'
19+
- in: query
20+
name: filters
21+
schema:
22+
type: string
23+
description: >-
24+
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
25+
26+
27+
Filtering is supported for the following fields and operators:
28+
29+
30+
**id**: *eq, in*
31+
32+
33+
**name**: *eq, in*
34+
35+
36+
**created**: *gt, lt, ge, le*
37+
38+
39+
**modified**: *gt, lt, ge, le*
40+
example: name eq "developer access profile"
41+
required: false
42+
style: form
43+
explode: true
44+
responses:
45+
'200':
46+
description: List of access profiles for the specified source app
47+
content:
48+
application/json:
49+
schema:
50+
type: array
51+
items:
52+
$ref: '../schemas/app/AccessProfileDetails.yaml'
53+
'400':
54+
$ref: '../../v3/responses/400.yaml'
55+
'401':
56+
$ref: '../../v3/responses/401.yaml'
57+
'403':
58+
$ref: '../../v3/responses/403.yaml'
59+
'429':
60+
$ref: '../../v3/responses/429.yaml'
61+
'500':
62+
$ref: '../../v3/responses/500.yaml'

‎idn/beta/paths/ears-source-app-bulk-update.yaml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
post:
2+
operationId: updateSourceAppsInBulk
3+
tags:
4+
- Apps
5+
summary: Bulk update source apps
6+
description: >-
7+
This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch.
8+
9+
The following fields can be updated:
10+
**name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**,
11+
**matchAllAccounts**, and **accessProfiles**.
12+
13+
Name, description and owner can't be empty or null.
14+
security:
15+
- UserContextAuth: [ idn:app-roles:manage ]
16+
requestBody:
17+
content:
18+
application/json:
19+
schema:
20+
$ref: '../schemas/app/SourceAppBulkUpdateRequest.yaml'
21+
responses:
22+
'204':
23+
$ref: "../../v3/responses/204.yaml"
24+
'400':
25+
$ref: '../../v3/responses/400.yaml'
26+
'401':
27+
$ref: '../../v3/responses/401.yaml'
28+
'403':
29+
$ref: '../../v3/responses/403.yaml'
30+
'404':
31+
$ref: '../../v3/responses/404.yaml'
32+
'429':
33+
$ref: '../../v3/responses/429.yaml'
34+
'500':
35+
$ref: '../../v3/responses/500.yaml'

‎idn/beta/paths/ears-source-app.yaml‎

Lines changed: 223 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,223 @@
1+
get:
2+
operationId: getSourceApp
3+
tags:
4+
- Apps
5+
summary: Get source app by ID
6+
description: >-
7+
This API returns a source app by its ID.
8+
security:
9+
- UserContextAuth: [idn:app-roles:read]
10+
parameters:
11+
- name: id
12+
in: path
13+
description: ID of the source app
14+
required: true
15+
schema:
16+
type: string
17+
example: 2c91808a7813090a017814121e121518
18+
responses:
19+
'200':
20+
description: Responds with the source app.
21+
content:
22+
application/json:
23+
schema:
24+
$ref: '../schemas/app/SourceApp.yaml'
25+
'400':
26+
$ref: '../../v3/responses/400.yaml'
27+
'401':
28+
$ref: '../../v3/responses/401.yaml'
29+
'403':
30+
$ref: '../../v3/responses/403.yaml'
31+
'404':
32+
$ref: '../../v3/responses/404.yaml'
33+
'429':
34+
$ref: '../../v3/responses/429.yaml'
35+
'500':
36+
$ref: '../../v3/responses/500.yaml'
37+
patch:
38+
operationId: patchSourceApp
39+
tags:
40+
- Apps
41+
summary: Patch source app by ID
42+
description: >-
43+
This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
44+
45+
The following fields are patchable:
46+
**name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**,
47+
**matchAllAccounts** and **accessProfiles**.
48+
49+
Name, description and owner can't be empty or null.
50+
security:
51+
- UserContextAuth: [idn:app-roles:manage]
52+
parameters:
53+
- name: id
54+
in: path
55+
description: ID of the source app to patch
56+
required: true
57+
schema:
58+
type: string
59+
example: 2c91808a7813090a017814121e121518
60+
requestBody:
61+
content:
62+
application/json-patch+json:
63+
schema:
64+
type: array
65+
items:
66+
$ref: '../schemas/JsonPatchOperation.yaml'
67+
example: [
68+
{
69+
"op": "replace",
70+
"path": "/enabled",
71+
"value": true
72+
}
73+
]
74+
examples:
75+
Make an app enabled and matchAllAccounts in one call:
76+
description: This example shows how multiple fields may be updated with a single patch call.
77+
value:
78+
[
79+
{
80+
"op": "replace",
81+
"path": "/enabled",
82+
"value": true
83+
},
84+
{
85+
"op": "replace",
86+
"path": "/matchAllAccounts",
87+
"value": true
88+
}
89+
]
90+
Replace an owner for an source app:
91+
description: >-
92+
This example shows how to use patch to replace the source app's owner by replacing the
93+
owner's info.
94+
value:
95+
[
96+
{
97+
"op": "replace",
98+
"path": "/owner",
99+
"value": {
100+
"id": "2c9180858315595501831958427e5424"
101+
}
102+
}
103+
]
104+
Update the description for the source app:
105+
description: >-
106+
This example shows how to use patch to update a description for the source app.
107+
value:
108+
[
109+
{
110+
"op": "replace",
111+
"path": "/description",
112+
"value": "new description for the source app"
113+
}
114+
]
115+
Update the name for the source app:
116+
description: >-
117+
This example shows how to use patch to update the source app's name.
118+
value:
119+
[
120+
{
121+
"op": "replace",
122+
"path": "/name",
123+
"value": "source app new name"
124+
}
125+
]
126+
Add access profiles:
127+
description: Add one or more access profiles to the end of the list
128+
value:
129+
[
130+
{
131+
"op": "add",
132+
"path": "/accessProfiles",
133+
"value": [
134+
"2c9180857725c14301772a93bb77242d",
135+
"c9575abb5e3a4e3db82b2f989a738aa2"
136+
]
137+
}
138+
]
139+
Insert access profile:
140+
description: Add an access profile at the beginning of the access profile list
141+
value:
142+
[
143+
{
144+
"op": "add",
145+
"path": "/accessProfiles/0",
146+
"value": "2c9180857725c14301772a93bb77242d"
147+
}
148+
]
149+
Replace access profiles:
150+
description: Replace all access profiles with a new list of access profiles
151+
value:
152+
[
153+
{
154+
"op": "replace",
155+
"path": "/accessProfiles",
156+
"value": [
157+
"2c9180857725c14301772a93bb77242d",
158+
"c9575abb5e3a4e3db82b2f989a738aa2"
159+
]
160+
}
161+
]
162+
Remove access profile:
163+
description: Remove the first access profile in the list
164+
value:
165+
[
166+
{
167+
"op": "remove",
168+
"path": "/accessProfiles/0"
169+
}
170+
]
171+
responses:
172+
'200':
173+
description: Responds with the source app as updated.
174+
content:
175+
application/json:
176+
schema:
177+
$ref: '../schemas/app/SourceAppPatchDto.yaml'
178+
'400':
179+
$ref: '../../v3/responses/400.yaml'
180+
'401':
181+
$ref: '../../v3/responses/401.yaml'
182+
'403':
183+
$ref: '../../v3/responses/403.yaml'
184+
'404':
185+
$ref: '../../v3/responses/404.yaml'
186+
'429':
187+
$ref: '../../v3/responses/429.yaml'
188+
'500':
189+
$ref: '../../v3/responses/500.yaml'
190+
delete:
191+
operationId: deleteSourceApp
192+
security:
193+
- UserContextAuth: [idn:app-roles:manage, idn:app-roles:delete]
194+
tags:
195+
- Apps
196+
summary: Delete source app by ID
197+
description: >-
198+
Use this API to delete a specific source app
199+
parameters:
200+
- in: path
201+
name: id
202+
schema:
203+
type: string
204+
required: true
205+
description: source app ID.
206+
example: 2c9180835d191a86015d28455b4a2329
207+
responses:
208+
'200':
209+
description: Responds with the source app as deleted.
210+
content:
211+
application/json:
212+
schema:
213+
$ref: '../schemas/app/SourceApp.yaml'
214+
'400':
215+
$ref: '../../v3/responses/400.yaml'
216+
'401':
217+
$ref: '../../v3/responses/401.yaml'
218+
'403':
219+
$ref: '../../v3/responses/403.yaml'
220+
'429':
221+
$ref: '../../v3/responses/429.yaml'
222+
'500':
223+
$ref: '../../v3/responses/500.yaml'

0 commit comments

Comments
 (0)