diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md index bcad27663..ed134e8a7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md @@ -77,12 +77,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" } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccess.md index 3e0592da2..6fae650b6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccess.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityWithNewAccess = Initialize-BetaIdentityWithNewAccess -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md index 36f36b58f..684c31063 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md @@ -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-BetaIdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` - -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Id 2c91809773dee32014e13e122092014e ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md index bb6406b61..ad71ba5d3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md @@ -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-V2024ViolationCheck -IdentityWithNewAccess1 $Result + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024ViolationCheck -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + # Start-V2024ViolationCheck -IdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef1.md deleted file mode 100644 index a506e7b79..000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: v2024-entitlement-ref1 -title: EntitlementRef1 -pagination_label: EntitlementRef1 -sidebar_label: EntitlementRef1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef1', 'V2024EntitlementRef1'] -slug: /tools/sdk/powershell/v2024/models/entitlement-ref1 -tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'V2024EntitlementRef1'] ---- - - -# 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-V2024EntitlementRef1 -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]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess.md index 43336262a..c731be213 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityWithNewAccess = Initialize-V2024IdentityWithNewAccess -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess1.md deleted file mode 100644 index 440acc135..000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: v2024-identity-with-new-access1 -title: IdentityWithNewAccess1 -pagination_label: IdentityWithNewAccess1 -sidebar_label: IdentityWithNewAccess1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] -slug: /tools/sdk/powershell/v2024/models/identity-with-new-access1 -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] ---- - - -# 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-V2024IdentityWithNewAccess1 -IdentityId 2c91809050db617d0150e0bf3215385e ` - -AccessRefs null ` - -ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} -``` - -- Convert the resource to JSON -```powershell -$IdentityWithNewAccess1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md index cfd575f2d..7c0e1e2f2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md @@ -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-V2024IdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` - -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Id 2c91809773dee32014e13e122092014e ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODViolationsApi.md index 664790661..3ef27796d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODViolationsApi.md @@ -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-V2025ViolationCheck -IdentityWithNewAccess1 $Result + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2025ViolationCheck -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + # Start-V2025ViolationCheck -IdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementRef1.md b/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementRef1.md deleted file mode 100644 index d1e8eb749..000000000 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementRef1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: v2025-entitlement-ref1 -title: EntitlementRef1 -pagination_label: EntitlementRef1 -sidebar_label: EntitlementRef1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef1', 'V2025EntitlementRef1'] -slug: /tools/sdk/powershell/v2025/models/entitlement-ref1 -tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'V2025EntitlementRef1'] ---- - - -# 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-V2025EntitlementRef1 -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]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccess.md index 600d7fa29..1c41d494b 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccess.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityWithNewAccess = Initialize-V2025IdentityWithNewAccess -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccess1.md deleted file mode 100644 index 27b7845fa..000000000 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccess1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: v2025-identity-with-new-access1 -title: IdentityWithNewAccess1 -pagination_label: IdentityWithNewAccess1 -sidebar_label: IdentityWithNewAccess1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess1', 'V2025IdentityWithNewAccess1'] -slug: /tools/sdk/powershell/v2025/models/identity-with-new-access1 -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'V2025IdentityWithNewAccess1'] ---- - - -# 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-V2025IdentityWithNewAccess1 -IdentityId 2c91809050db617d0150e0bf3215385e ` - -AccessRefs null ` - -ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} -``` - -- Convert the resource to JSON -```powershell -$IdentityWithNewAccess1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md index 8652fece6..8feb4af4e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityWithNewAccessAccessRefsInner.md @@ -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-V2025IdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` - -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Id 2c91809773dee32014e13e122092014e ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md index c51d51c87..a038fa88e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef1.md b/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef1.md deleted file mode 100644 index 2707155e1..000000000 --- a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef1.md +++ /dev/null @@ -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]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess.md index 7c38d3341..81b0d609c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess1.md deleted file mode 100644 index aabe7f4d9..000000000 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess1.md +++ /dev/null @@ -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]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md index 9c0bf3a61..0f7fed831 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md @@ -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 diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index e2cd5b55f..e7cbe4227 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -10594,12 +10594,10 @@ "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" } ] } "@ diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 2bd81a803..e6afcda9c 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -13937,12 +13937,10 @@ "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" } ] } "@ @@ -13965,18 +13963,27 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check source: | - $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-V2024ViolationCheck -IdentityWithNewAccess1 $Result + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024ViolationCheck -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + # Start-V2024ViolationCheck -IdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" Write-Host $_.ErrorDetails diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index 53faff5be..734c9a9ca 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -14714,12 +14714,10 @@ "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" } ] } "@ @@ -14742,18 +14740,27 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check source: | - $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-V2025ViolationCheck -IdentityWithNewAccess1 $Result + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2025ViolationCheck -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + # Start-V2025ViolationCheck -IdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" Write-Host $_.ErrorDetails diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index 6bf3f9fc2..772432d95 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -6735,12 +6735,10 @@ "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" } ] } "@ @@ -6763,18 +6761,27 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check source: | - $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