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

Update PowerShell SDK docs: 17132181964

Browse Source
This commit is contained in:
developer-relations-sp
2025-08-21 15:56:04 +00:00
parent e06178ec15
commit 7681b97803
22 changed files with 108 additions and 312 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md
View File

@@ -73,12 +73,10 @@ $IdentityWithNewAccess = @"{
"identityId" : "2c91808568c529c60168cca6f90c1313",
"accessRefs" : [ {
"type" : "ENTITLEMENT",
"id" : "2c918087682f9a86016839c050861ab1",
"name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local"
"id" : "2c918087682f9a86016839c050861ab1"
}, {
"type" : "ENTITLEMENT",
"id" : "2c918087682f9a86016839c0509c1ab2",
"name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local"
"id" : "2c918087682f9a86016839c0509c1ab2"
} ]
}"@
@@ -105,7 +103,7 @@ This API initiates a SOD policy verification asynchronously.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | IdentityWithNewAccess1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True |
Body | IdentityWithNewAccess | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True |
### Return type
[**SodViolationCheck**](../models/sod-violation-check)
@@ -127,16 +125,25 @@ Code | Description | Data Type
### Example
```powershell
$IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}"@
$IdentityWithNewAccess = @"{
"identityId" : "2c91808568c529c60168cca6f90c1313",
"accessRefs" : [ {
"type" : "ENTITLEMENT",
"id" : "2c918087682f9a86016839c050861ab1"
}, {
"type" : "ENTITLEMENT",
"id" : "2c918087682f9a86016839c0509c1ab2"
} ]
}"@
# Check sod violations
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1
Start-ViolationCheck -IdentityWithNewAccess1 $Result
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess
Start-ViolationCheck -IdentityWithNewAccess $Result
# Below is a request that includes all optional parameters
# Start-ViolationCheck -IdentityWithNewAccess1 $Result
# Start-ViolationCheck -IdentityWithNewAccess $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck"
Write-Host $_.ErrorDetails

39
docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef1.md
View File

@@ -1,39 +0,0 @@
---
id: entitlement-ref1
title: EntitlementRef1
pagination_label: EntitlementRef1
sidebar_label: EntitlementRef1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef1', 'EntitlementRef1']
slug: /tools/sdk/powershell/v3/models/entitlement-ref1
tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'EntitlementRef1']
---
# EntitlementRef1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional]
**Id** | **String** | Entitlement's ID. | [optional]
**Name** | **String** | Entitlement's display name. | [optional]
## Examples
- Prepare the resource
```powershell
$EntitlementRef1 = Initialize-EntitlementRef1 -Type ENTITLEMENT `
-Id 2c91809773dee32014e13e122092014e `
-Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local
```
- Convert the resource to JSON
```powershell
$EntitlementRef1 | ConvertTo-JSON
```
[[Back to top]](#)

2
docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$IdentityWithNewAccess = Initialize-IdentityWithNewAccess -IdentityId 2c91808568c529c60168cca6f90c1313 `
-AccessRefs [{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}]
-AccessRefs [{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]
```
- Convert the resource to JSON

39
docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess1.md
View File

@@ -1,39 +0,0 @@
---
id: identity-with-new-access1
title: IdentityWithNewAccess1
pagination_label: IdentityWithNewAccess1
sidebar_label: IdentityWithNewAccess1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1']
slug: /tools/sdk/powershell/v3/models/identity-with-new-access1
tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1']
---
# IdentityWithNewAccess1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**IdentityId** | **String** | Set of identity IDs to be checked. | [required]
**AccessRefs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [required]
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional]
## Examples
- Prepare the resource
```powershell
$IdentityWithNewAccess1 = Initialize-IdentityWithNewAccess1 -IdentityId 2c91809050db617d0150e0bf3215385e `
-AccessRefs null `
-ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1}
```
- Convert the resource to JSON
```powershell
$IdentityWithNewAccess1 | ConvertTo-JSON
```
[[Back to top]](#)

4
docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md
View File

@@ -18,15 +18,13 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional]
**Id** | **String** | Entitlement's ID. | [optional]
**Name** | **String** | Entitlement's display name. | [optional]
## Examples
- Prepare the resource
```powershell
$IdentityWithNewAccessAccessRefsInner = Initialize-IdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT `
-Id 2c91809773dee32014e13e122092014e `
-Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local
-Id 2c91809773dee32014e13e122092014e
```
- Convert the resource to JSON