LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

update for mermaidviewer

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-03-12 14:54:01 -04:00
parent 184517209d
commit 870a2b231b
7 changed files with 311 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
src/components/MermaidViewer.tsx
View File

@@ -2,26 +2,25 @@ import React, { useState, useEffect } from 'react';
import mermaid from 'mermaid';
import useBaseUrl from '@docusaurus/useBaseUrl';
import styles from './styles.module.css';
interface MermaidViewerProps {
diagram: string;
}
interface CursorState {
cursor: string;
cursor: 'grab' | 'grabbing';
clickX: number;
clickY: number;
offsetX: number;
offsetY: number;
}
interface CursorPosition {
interface MovingState {
x: number;
y: number;
}
const MermaidViewer: React.FC<MermaidViewerProps> = ({ diagram }) => {
const [width, setWidth] = useState(0);
mermaid.contentLoaded();
const [width, setWidth] = useState<number>(0);
const [mermaidCursorStart, setMermaidCursorStart] = useState<CursorState>({
cursor: 'grab',
clickX: 0,
@@ -29,21 +28,23 @@ const MermaidViewer: React.FC<MermaidViewerProps> = ({ diagram }) => {
offsetX: 0,
offsetY: 0,
});
const [mermaidCursorMoving, setMermaidCursorMoving] = useState<CursorPosition>({
const [mermaidCursorMoving, setMermaidCursorMoving] = useState<MovingState>({
x: 0,
y: 0,
});
const [mermaidRender, setMermaidRender] = useState(false);
const increaseWidth = () => setWidth(width + 300);
const decreaseWidth = () => setWidth(width - 300);
const [mermaidRender, setMermaidRender] = useState<boolean>(false);
const resetWidth = (e: React.MouseEvent | React.TouchEvent) => {
const increaseWidth = () => setWidth((prev) => prev + 300);
const decreaseWidth = () => setWidth((prev) => prev - 300);
const resetWidth = (e: React.MouseEvent<HTMLImageElement>) => {
setWidth(0);
setMermaidCursorStart({
cursor: 'grab',
clickX: (e instanceof MouseEvent ? e.screenX : e.changedTouches[0].screenX) || 0,
clickY: (e instanceof MouseEvent ? e.screenY : e.changedTouches[0].screenY) || 0,
clickX: e.screenX,
clickY: e.screenY,
offsetX: 0,
offsetY: 0,
});
@@ -51,8 +52,8 @@ const MermaidViewer: React.FC<MermaidViewerProps> = ({ diagram }) => {
};
const setMouseDown = (e: React.MouseEvent | React.TouchEvent) => {
const screenX = e instanceof MouseEvent ? e.screenX : e.changedTouches[0].screenX;
const screenY = e instanceof MouseEvent ? e.screenY : e.changedTouches[0].screenY;
const screenX = 'screenX' in e ? e.screenX : e.changedTouches[0].screenX;
const screenY = 'screenY' in e ? e.screenY : e.changedTouches[0].screenY;
setMermaidCursorStart({
cursor: 'grabbing',
@@ -61,21 +62,16 @@ const MermaidViewer: React.FC<MermaidViewerProps> = ({ diagram }) => {
offsetX: mermaidCursorMoving.x,
offsetY: mermaidCursorMoving.y,
});
setMermaidCursorMoving({
x: mermaidCursorMoving.x,
y: mermaidCursorMoving.y,
});
};
const setMouseUp = () => {
setMermaidCursorStart({ cursor: 'grab', clickX: 0, clickY: 0 });
setMermaidCursorStart((prev) => ({ ...prev, cursor: 'grab' }));
};
const drag = (e: React.MouseEvent | React.TouchEvent) => {
if (mermaidCursorStart.cursor === 'grabbing') {
const screenX = e instanceof MouseEvent ? e.screenX : e.changedTouches[0].screenX;
const screenY = e instanceof MouseEvent ? e.screenY : e.changedTouches[0].screenY;
const screenX = 'screenX' in e ? e.screenX : e.changedTouches[0].screenX;
const screenY = 'screenY' in e ? e.screenY : e.changedTouches[0].screenY;
setMermaidCursorMoving({
x: mermaidCursorStart.clickX - screenX + mermaidCursorStart.offsetX,
@@ -85,58 +81,21 @@ const MermaidViewer: React.FC<MermaidViewerProps> = ({ diagram }) => {
};
useEffect(() => {
setMermaidRender(true); // Immediately set render state
let canceled = false;
setTimeout(() => {
const timeout = setTimeout(() => {
if (!canceled) {
setMermaidRender(true);
}
}, 100);
}, 100); // Small delay to ensure mermaid.js processes correctly
return () => {
canceled = true;
clearTimeout(timeout);
};
}, []);
let renderedDiagram;
let loadingIndicator;
if (mermaidRender) {
loadingIndicator = <div></div>;
renderedDiagram = (
<div
id="mermaid"
draggable="false"
className="mermaid"
style={{
position: 'relative',
top: -mermaidCursorMoving.y + 'px',
left: -mermaidCursorMoving.x + 'px',
width: `calc(100% + ${width}px)`,
maxHeight: '1000px',
}}
>
{diagram}
</div>
);
} else {
loadingIndicator = <div>Diagram Loading ...</div>;
renderedDiagram = (
<div
id="mermaid"
draggable="false"
className="mermaid"
style={{
visibility: 'hidden',
position: 'relative',
top: -mermaidCursorMoving.y + 'px',
left: -mermaidCursorMoving.x + 'px',
width: `calc(100% + ${width}px)`,
maxHeight: '1000px',
}}
>
{diagram}
</div>
);
}
return (
<div>
@@ -148,7 +107,7 @@ const MermaidViewer: React.FC<MermaidViewerProps> = ({ diagram }) => {
/>
<img
className={styles.zoomIn}
onClick={(e) => resetWidth(e)}
onClick={resetWidth}
src={useBaseUrl('/icons/house-regular.svg')}
alt="Reset Zoom"
/>
@@ -169,8 +128,24 @@ const MermaidViewer: React.FC<MermaidViewerProps> = ({ diagram }) => {
onTouchEnd={setMouseUp}
onMouseLeave={setMouseUp}
>
{loadingIndicator}
{renderedDiagram}
{mermaidRender ? (
<div
id="mermaid"
draggable="false"
className="mermaid"
style={{
position: 'relative',
top: -mermaidCursorMoving.y + 'px',
left: -mermaidCursorMoving.x + 'px',
width: `calc(100% + ${width}px)`,
maxHeight: '1000px',
}}
>
{diagram}
</div>
) : (
<div>Diagram Loading ...</div>
)}
</div>
</div>
);

152
static/code-examples/beta/beta.yaml
View File

@@ -7425,6 +7425,11 @@ paths:
operationId: getAccessRequestRecommendations
tags:
- IAI Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:read
x-sailpoint-userLevels:
- Any
summary: Identity Access Request Recommendations
description: This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.
parameters:
@@ -7442,9 +7447,11 @@ paths:
required: false
schema:
type: integer
format: int32
minimum: 0
maximum: 15
default: 15
example: 15
- $ref: '#/paths/~1access-profiles/get/parameters/2'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/parameters/offset.yaml
- $ref: '#/paths/~1access-profiles/get/parameters/3'
@@ -7471,6 +7478,7 @@ paths:
**access.type**: *eq, in*
**access.description**: *co, eq, in*
required: false
example: access.name co "admin"
- in: query
name: sorters
@@ -7483,6 +7491,8 @@ paths:
Sorting is supported for the following fields: **access.name, access.type**
By default the recommendations are sorted by highest confidence first.
required: false
example: access.name
responses:
'200':
description: List of access request recommendations for the identityId
@@ -7573,12 +7583,12 @@ paths:
label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations
source: |
$IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me")
$Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15)
$Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false)
$Filters = "access.name co "admin"" # String | 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
$Sorters = "access.name" # String | 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
# Identity Access Request Recommendations
@@ -7617,7 +7627,12 @@ paths:
operationId: addAccessRequestRecommendationsIgnoredItem
tags:
- IAI Access Request Recommendations
summary: Notification of Ignored Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: Ignore Access Request Recommendation
description: This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.
requestBody:
description: The recommended access item to ignore for an identity.
@@ -7695,7 +7710,7 @@ paths:
}
"@
# Notification of Ignored Access Request Recommendations
# Ignore Access Request Recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -7732,7 +7747,12 @@ paths:
operationId: getAccessRequestRecommendationsIgnoredItems
tags:
- IAI Access Request Recommendations
summary: List of Ignored Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: List Ignored Access Request Recommendations
description: This API returns the list of ignored access request recommendations.
parameters:
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
@@ -7755,6 +7775,7 @@ paths:
**access.type**: *eq, in*
**identityId**: *eq, in*
required: false
example: identityId eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
@@ -7765,6 +7786,7 @@ paths:
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: **access.id, access.type, identityId, timestamp**
required: false
example: access.id
responses:
'200':
@@ -7801,7 +7823,7 @@ paths:
$Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Ignored Access Request Recommendations
# List Ignored Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsIgnoredItems
@@ -7836,7 +7858,12 @@ paths:
operationId: addAccessRequestRecommendationsRequestedItem
tags:
- IAI Access Request Recommendations
summary: Notification of Requested Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: Accept Access Request Recommendation
description: This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.
requestBody:
description: The recommended access item that was requested for an identity.
@@ -7883,7 +7910,7 @@ paths:
}
"@
# Notification of Requested Access Request Recommendations
# Accept Access Request Recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -7920,7 +7947,12 @@ paths:
operationId: getAccessRequestRecommendationsRequestedItems
tags:
- IAI Access Request Recommendations
summary: List of Requested Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: List Accepted Access Request Recommendations
description: This API returns a list of requested access request recommendations.
parameters:
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
@@ -7943,6 +7975,7 @@ paths:
**access.type**: *eq, in*
**identityId**: *eq, in*
required: false
example: access.id eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
@@ -7953,6 +7986,8 @@ paths:
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: **access.id, access.type, identityId, timestamp**
required: false
example: access.id
responses:
'200':
description: Returns the list of requested access request recommendations.
@@ -7986,9 +8021,9 @@ paths:
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Requested Access Request Recommendations
# List Accepted Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsRequestedItems
@@ -8023,7 +8058,12 @@ paths:
operationId: addAccessRequestRecommendationsViewedItem
tags:
- IAI Access Request Recommendations
summary: Notification of Viewed Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: Mark Viewed Access Request Recommendations
description: This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
requestBody:
description: The recommended access that was viewed for an identity.
@@ -8070,7 +8110,7 @@ paths:
}
"@
# Notification of Viewed Access Request Recommendations
# Mark Viewed Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -8107,7 +8147,12 @@ paths:
operationId: getAccessRequestRecommendationsViewedItems
tags:
- IAI Access Request Recommendations
summary: List of Viewed Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:read
x-sailpoint-userLevels:
- Any
summary: List Viewed Access Request Recommendations
description: This API returns the list of viewed access request recommendations.
parameters:
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
@@ -8130,6 +8175,7 @@ paths:
**access.type**: *eq, in*
**identityId**: *eq, in*
required: false
example: access.id eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
@@ -8140,6 +8186,8 @@ paths:
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: **access.id, access.type, identityId, timestamp**
required: false
example: access.id
responses:
'200':
description: Returns list of viewed access request recommendations.
@@ -8173,9 +8221,9 @@ paths:
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Viewed Access Request Recommendations
# List Viewed Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsViewedItems
@@ -8210,7 +8258,12 @@ paths:
operationId: addAccessRequestRecommendationsViewedItems
tags:
- IAI Access Request Recommendations
summary: Notification of Viewed Access Request Recommendations in Bulk
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: Bulk Mark Viewed Access Request Recommendations
description: This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
requestBody:
description: The recommended access items that were viewed for an identity.
@@ -8260,7 +8313,7 @@ paths:
}"@
# Notification of Viewed Access Request Recommendations in Bulk
# Bulk Mark Viewed Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -41933,7 +41986,7 @@ paths:
/recommendations/request:
post:
operationId: getRecommendations
summary: Returns a Recommendation Based on Object
summary: Returns Recommendation Based on Object
tags:
- IAI Recommendations
description: The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.
@@ -41999,7 +42052,10 @@ paths:
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/500'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
security:
- userAuth: []
- userAuth:
- iai:decisions:manage
x-sailpoint-userLevels:
- Any
x-codeSamples:
- lang: PowerShell
label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations
@@ -42123,11 +42179,17 @@ paths:
'403':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/403'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
'429':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/429'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
'500':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/500'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
security:
- userAuth: []
- userAuth:
- iai:configuration:read
x-sailpoint-userLevels:
- ORG_ADMIN
x-codeSamples:
- lang: PowerShell
label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#get-recommendations-config
@@ -42188,11 +42250,17 @@ paths:
'403':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/403'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
'429':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/429'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
'500':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/500'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
security:
- userAuth: []
- userAuth:
- iai:configuration:manage
x-sailpoint-userLevels:
- ORG_ADMIN
x-codeSamples:
- lang: PowerShell
label: SDK_tools/sdk/powershell/beta/methods/iai-recommendations#update-recommendations-config
@@ -63353,7 +63421,10 @@ paths:
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/500'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
security:
- userAuth: []
- userAuth:
- iai:decisions:manage
x-sailpoint-userLevels:
- Any
x-codeSamples:
- lang: PowerShell
label: SDK_tools/sdk/powershell/beta/methods/iai-message-catalogs#get-message-catalogs
@@ -71510,6 +71581,7 @@ paths:
type: string
description: ID of the work item owner.
required: false
example: 2c9180835d191a86015d28455b4a2329
- in: path
name: id
schema:
@@ -71517,31 +71589,40 @@ paths:
required: true
x-sailpoint-resource-operation-id: listWorkItems
description: ID of the work item.
example: 2c9180835d191a86015d28455b4a2329
responses:
'200':
description: The work item with the given ID.
content:
application/json:
schema:
type: array
items:
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/beta/schemas/WorkItems.yaml
'400':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/400'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
'401':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/401'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
'403':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/403'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
'404':
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
'429':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/429'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
'500':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/500'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
x-codeSamples:
- lang: PowerShell
label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item
source: |
$Id = "MyId" # String | ID of the work item.
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
$OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional)
# Get a Work Item
@@ -71585,6 +71666,13 @@ paths:
x-sailpoint-resource-operation-id: listWorkItems
description: The ID of the work item
example: ef38f94347e94562b5bb8424a56397d8
requestBody:
description: Body is the request payload to create form definition request
content:
application/json:
schema:
type: string
nullable: true
responses:
'200':
description: A WorkItems object
@@ -71596,17 +71684,27 @@ paths:
'400':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/400'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
'401':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/401'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
'403':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/403'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/403.yaml
'404':
$ref: '#/paths/~1access-requests~1cancel/post/responses/404'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/404.yaml
'429':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/429'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/429.yaml
'500':
$ref: '#/paths/~1access-model-metadata~1attributes/get/responses/500'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/500.yaml
x-codeSamples:
- lang: PowerShell
label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item
@@ -71614,7 +71712,7 @@ paths:
Complete-BetaWorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-BetaWorkItem -Id $Id
# Complete-BetaWorkItem -Id $Id -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem"
Write-Host $_.ErrorDetails

29
static/code-examples/beta/merged_code_examples.yaml
View File

@@ -7397,7 +7397,7 @@
}
"@
# Notification of Ignored Access Request Recommendations
# Ignore Access Request Recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -7442,7 +7442,7 @@
$Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Ignored Access Request Recommendations
# List Ignored Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsIgnoredItems
@@ -7488,7 +7488,7 @@
}
"@
# Notification of Requested Access Request Recommendations
# Accept Access Request Recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -7531,9 +7531,9 @@
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Requested Access Request Recommendations
# List Accepted Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsRequestedItems
@@ -7579,7 +7579,7 @@
}
"@
# Notification of Viewed Access Request Recommendations
# Mark Viewed Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -7622,9 +7622,9 @@
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Viewed Access Request Recommendations
# List Viewed Access Request Recommendations
try {
Get-BetaAccessRequestRecommendationsViewedItems
@@ -7669,7 +7669,7 @@
}"@
# Notification of Viewed Access Request Recommendations in Bulk
# Bulk Mark Viewed Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -7711,12 +7711,12 @@
label: SDK_tools/sdk/powershell/beta/methods/iai-access-request-recommendations#get-access-request-recommendations
source: |
$IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me")
$Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15)
$Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false)
$Filters = "access.name co "admin"" # String | 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
$Sorters = "access.name" # String | 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
# Identity Access Request Recommendations
@@ -24808,6 +24808,7 @@
label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item
@@ -24815,7 +24816,7 @@
Complete-BetaWorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-BetaWorkItem -Id $Id
# Complete-BetaWorkItem -Id $Id -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem"
Write-Host $_.ErrorDetails
@@ -24841,8 +24842,8 @@
- lang: PowerShell
label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item
source: |
$Id = "MyId" # String | ID of the work item.
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
$OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional)
# Get a Work Item

25
static/code-examples/v2024/merged_code_examples.yaml
View File

@@ -10362,7 +10362,7 @@
}
"@
# Notification of Ignored Access Request Recommendations
# Ignore Access Request Recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -10409,7 +10409,7 @@
$Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Ignored Access Request Recommendations
# List Ignored Access Request Recommendations
try {
Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental
@@ -10457,7 +10457,7 @@
}
"@
# Notification of Requested Access Request Recommendations
# Accept Access Request Recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -10502,9 +10502,9 @@
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Requested Access Request Recommendations
# List Accepted Access Request Recommendations
try {
Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental
@@ -10552,7 +10552,7 @@
}
"@
# Notification of Viewed Access Request Recommendations
# Mark Viewed Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -10597,9 +10597,9 @@
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Viewed Access Request Recommendations
# List Viewed Access Request Recommendations
try {
Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental
@@ -10646,7 +10646,7 @@
}"@
# Notification of Viewed Access Request Recommendations in Bulk
# Bulk Mark Viewed Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -10690,12 +10690,12 @@
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me")
$Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15)
$Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false)
$Filters = "access.name co "admin"" # String | 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
$Sorters = "access.name" # String | 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
# Identity Access Request Recommendations
@@ -30181,6 +30181,7 @@
label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item
@@ -30188,7 +30189,7 @@
Complete-V2024WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-V2024WorkItem -Id $Id
# Complete-V2024WorkItem -Id $Id -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem"
Write-Host $_.ErrorDetails

122
static/code-examples/v2024/v2024.yaml
View File

@@ -53372,6 +53372,13 @@ paths:
x-sailpoint-resource-operation-id: listWorkItems
description: The ID of the work item
example: ef38f94347e94562b5bb8424a56397d8
requestBody:
description: Body is the request payload to create form definition request
content:
application/json:
schema:
type: string
nullable: true
responses:
'200':
description: A WorkItems object
@@ -53403,6 +53410,7 @@ paths:
label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item
@@ -53410,7 +53418,7 @@ paths:
Complete-V2024WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-V2024WorkItem -Id $Id
# Complete-V2024WorkItem -Id $Id -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem"
Write-Host $_.ErrorDetails
@@ -58016,6 +58024,11 @@ paths:
operationId: getAccessRequestRecommendations
tags:
- IAI Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:read
x-sailpoint-userLevels:
- Any
summary: Identity Access Request Recommendations
description: This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user.
parameters:
@@ -58033,9 +58046,11 @@ paths:
required: false
schema:
type: integer
format: int32
minimum: 0
maximum: 15
default: 15
example: 15
- $ref: '#/paths/~1access-profiles/get/parameters/2'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/parameters/offset.yaml
- $ref: '#/paths/~1access-profiles/get/parameters/3'
@@ -58062,6 +58077,7 @@ paths:
**access.type**: *eq, in*
**access.description**: *co, eq, in*
required: false
example: access.name co "admin"
- in: query
name: sorters
@@ -58074,6 +58090,8 @@ paths:
Sorting is supported for the following fields: **access.name, access.type**
By default the recommendations are sorted by highest confidence first.
required: false
example: access.name
- name: X-SailPoint-Experimental
in: header
description: Use this header to enable this experimental API.
@@ -58185,12 +58203,12 @@ paths:
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me")
$Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15)
$Limit = 15 # Int32 | Max number of results to return. (optional) (default to 15)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false)
$Filters = "access.name co "admin"" # String | 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
$Sorters = "access.name" # String | 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
# Identity Access Request Recommendations
@@ -58436,7 +58454,12 @@ paths:
operationId: addAccessRequestRecommendationsIgnoredItem
tags:
- IAI Access Request Recommendations
summary: Notification of Ignored Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: Ignore Access Request Recommendation
description: This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.
requestBody:
description: The recommended access item to ignore for an identity.
@@ -58524,7 +58547,7 @@ paths:
}
"@
# Notification of Ignored Access Request Recommendations
# Ignore Access Request Recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -58562,7 +58585,12 @@ paths:
operationId: getAccessRequestRecommendationsIgnoredItems
tags:
- IAI Access Request Recommendations
summary: List of Ignored Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: List Ignored Access Request Recommendations
description: This API returns the list of ignored access request recommendations.
parameters:
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
@@ -58585,6 +58613,7 @@ paths:
**access.type**: *eq, in*
**identityId**: *eq, in*
required: false
example: identityId eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
@@ -58595,6 +58624,7 @@ paths:
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: **access.id, access.type, identityId, timestamp**
required: false
example: access.id
- name: X-SailPoint-Experimental
in: header
@@ -58640,7 +58670,7 @@ paths:
$Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Ignored Access Request Recommendations
# List Ignored Access Request Recommendations
try {
Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental
@@ -58676,7 +58706,12 @@ paths:
operationId: addAccessRequestRecommendationsRequestedItem
tags:
- IAI Access Request Recommendations
summary: Notification of Requested Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: Accept Access Request Recommendation
description: This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.
requestBody:
description: The recommended access item that was requested for an identity.
@@ -58733,7 +58768,7 @@ paths:
}
"@
# Notification of Requested Access Request Recommendations
# Accept Access Request Recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -58771,7 +58806,12 @@ paths:
operationId: getAccessRequestRecommendationsRequestedItems
tags:
- IAI Access Request Recommendations
summary: List of Requested Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: List Accepted Access Request Recommendations
description: This API returns a list of requested access request recommendations.
parameters:
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
@@ -58794,6 +58834,7 @@ paths:
**access.type**: *eq, in*
**identityId**: *eq, in*
required: false
example: access.id eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
@@ -58804,6 +58845,8 @@ paths:
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: **access.id, access.type, identityId, timestamp**
required: false
example: access.id
- name: X-SailPoint-Experimental
in: header
description: Use this header to enable this experimental API.
@@ -58846,9 +58889,9 @@ paths:
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Requested Access Request Recommendations
# List Accepted Access Request Recommendations
try {
Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental
@@ -58884,7 +58927,12 @@ paths:
operationId: addAccessRequestRecommendationsViewedItem
tags:
- IAI Access Request Recommendations
summary: Notification of Viewed Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: Mark Viewed Access Request Recommendations
description: This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
requestBody:
description: The recommended access that was viewed for an identity.
@@ -58941,7 +58989,7 @@ paths:
}
"@
# Notification of Viewed Access Request Recommendations
# Mark Viewed Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -58979,7 +59027,12 @@ paths:
operationId: getAccessRequestRecommendationsViewedItems
tags:
- IAI Access Request Recommendations
summary: List of Viewed Access Request Recommendations
security:
- userAuth:
- iai:access-request-recommender:read
x-sailpoint-userLevels:
- Any
summary: List Viewed Access Request Recommendations
description: This API returns the list of viewed access request recommendations.
parameters:
- $ref: '#/paths/~1access-profiles~1%7Bid%7D~1entitlements/get/parameters/1'
@@ -59002,6 +59055,7 @@ paths:
**access.type**: *eq, in*
**identityId**: *eq, in*
required: false
example: access.id eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
@@ -59012,6 +59066,8 @@ paths:
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: **access.id, access.type, identityId, timestamp**
required: false
example: access.id
- name: X-SailPoint-Experimental
in: header
description: Use this header to enable this experimental API.
@@ -59054,9 +59110,9 @@ paths:
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "MySorters" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
$Sorters = "access.id" # String | 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: **access.id, access.type, identityId, timestamp** (optional)
# List of Viewed Access Request Recommendations
# List Viewed Access Request Recommendations
try {
Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental
@@ -59092,7 +59148,12 @@ paths:
operationId: addAccessRequestRecommendationsViewedItems
tags:
- IAI Access Request Recommendations
summary: Notification of Viewed Access Request Recommendations in Bulk
security:
- userAuth:
- iai:access-request-recommender:manage
x-sailpoint-userLevels:
- Any
summary: Bulk Mark Viewed Access Request Recommendations
description: This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
requestBody:
description: The recommended access items that were viewed for an identity.
@@ -59152,7 +59213,7 @@ paths:
}"@
# Notification of Viewed Access Request Recommendations in Bulk
# Bulk Mark Viewed Access Request Recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -73370,7 +73431,7 @@ paths:
/recommendations/request:
post:
operationId: getRecommendations
summary: Returns a Recommendation Based on Object
summary: Returns Recommendation Based on Object
tags:
- IAI Recommendations
description: The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.
@@ -73536,7 +73597,10 @@ paths:
$ref: '#/paths/~1access-profiles/get/responses/500'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml
security:
- userAuth: []
- userAuth:
- iai:decisions:manage
x-sailpoint-userLevels:
- Any
parameters:
- name: X-SailPoint-Experimental
in: header
@@ -73671,11 +73735,17 @@ paths:
'403':
$ref: '#/paths/~1access-profiles/get/responses/403'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml
'429':
$ref: '#/paths/~1access-profiles/get/responses/429'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml
'500':
$ref: '#/paths/~1access-profiles/get/responses/500'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml
security:
- userAuth: []
- userAuth:
- iai:configuration:read
x-sailpoint-userLevels:
- ORG_ADMIN
parameters:
- name: X-SailPoint-Experimental
in: header
@@ -73747,11 +73817,17 @@ paths:
'403':
$ref: '#/paths/~1access-profiles/get/responses/403'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/403.yaml
'429':
$ref: '#/paths/~1access-profiles/get/responses/429'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/429.yaml
'500':
$ref: '#/paths/~1access-profiles/get/responses/500'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v2024/responses/500.yaml
security:
- userAuth: []
- userAuth:
- iai:configuration:manage
x-sailpoint-userLevels:
- ORG_ADMIN
parameters:
- name: X-SailPoint-Experimental
in: header

3
static/code-examples/v3/merged_code_examples.yaml
View File

@@ -17071,6 +17071,7 @@
label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item
@@ -17078,7 +17079,7 @@
Complete-WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-WorkItem -Id $Id
# Complete-WorkItem -Id $Id -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem"
Write-Host $_.ErrorDetails

13
static/code-examples/v3/v3.yaml
View File

@@ -50746,6 +50746,9 @@ paths:
schema:
$ref: '#/paths/~1work-items/get/responses/200/content/application~1json/schema/items'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/schemas/WorkItems.yaml
'400':
$ref: '#/paths/~1access-profiles/get/responses/400'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/400.yaml
'401':
$ref: '#/paths/~1access-profiles/get/responses/401'
x-miro: c:/Users/darrell.thobe/Desktop/developer_sailpoint_website/developer.sailpoint.com/static/api-specs/idn/v3/responses/401.yaml
@@ -50808,6 +50811,13 @@ paths:
x-sailpoint-resource-operation-id: listWorkItems
description: The ID of the work item
example: ef38f94347e94562b5bb8424a56397d8
requestBody:
description: Body is the request payload to create form definition request
content:
application/json:
schema:
type: string
nullable: true
responses:
'200':
description: A WorkItems object
@@ -50839,6 +50849,7 @@ paths:
label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item
@@ -50846,7 +50857,7 @@ paths:
Complete-WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-WorkItem -Id $Id
# Complete-WorkItem -Id $Id -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem"
Write-Host $_.ErrorDetails