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

Update to powershell SDK docs: 13123805130

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 22:09:17 +00:00
parent bdb088c15d
commit 3e9d359da1
2608 changed files with 14669 additions and 14876 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md
View File

@@ -1,4 +1,3 @@
---
id: access-profiles
title: AccessProfiles
@@ -179,7 +178,7 @@ $AccessProfile = @"{
try {
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
New-AccessProfile-AccessProfile $Result
New-AccessProfile -AccessProfile $Result
# Below is a request that includes all optional parameters
# New-AccessProfile -AccessProfile $AccessProfile
@@ -225,7 +224,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
# Delete the specified Access Profile
try {
Remove-AccessProfile-Id $Id
Remove-AccessProfile -Id $Id
# Below is a request that includes all optional parameters
# Remove-AccessProfile -Id $Id
@@ -276,7 +275,7 @@ $AccessProfileBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
Remove-AccessProfilesInBulk-AccessProfileBulkDeleteRequest $Result
Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest
@@ -318,7 +317,7 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile
# Get an Access Profile
try {
Get-AccessProfile-Id $Id
Get-AccessProfile -Id $Id
# Below is a request that includes all optional parameters
# Get-AccessProfile -Id $Id
@@ -372,7 +371,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
# List Access Profile's Entitlements
try {
Get-AccessProfileEntitlements-Id $Id
Get-AccessProfileEntitlements -Id $Id
# Below is a request that includes all optional parameters
# Get-AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -508,7 +507,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AccessProfile-Id $Id -JsonPatchOperation $Result
Update-AccessProfile -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AccessProfile -Id $Id -JsonPatchOperation $JsonPatchOperation

7
docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md
View File

@@ -1,4 +1,3 @@
---
id: access-request-approvals
title: AccessRequestApprovals
@@ -85,7 +84,7 @@ $CommentDto = @"{
# Approve Access Request Approval
try {
Approve-AccessRequest-ApprovalId $ApprovalId
Approve-AccessRequest -ApprovalId $ApprovalId
# Below is a request that includes all optional parameters
# Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto
@@ -134,7 +133,7 @@ $ForwardApprovalDto = @"{
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
Invoke-ForwardAccessRequest-ApprovalId $ApprovalId -ForwardApprovalDto $Result
Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
# Below is a request that includes all optional parameters
# Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $ForwardApprovalDto
@@ -336,7 +335,7 @@ $CommentDto = @"{
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
Deny-AccessRequest-ApprovalId $ApprovalId -CommentDto $Result
Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
# Below is a request that includes all optional parameters
# Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto

7
docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md
View File

@@ -1,4 +1,3 @@
---
id: access-requests
title: AccessRequests
@@ -77,7 +76,7 @@ $CancelAccessRequest = @"{
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
Suspend-AccessRequest-CancelAccessRequest $Result
Suspend-AccessRequest -CancelAccessRequest $Result
# Below is a request that includes all optional parameters
# Suspend-AccessRequest -CancelAccessRequest $CancelAccessRequest
@@ -203,7 +202,7 @@ $AccessRequest = @"{
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
New-AccessRequest-AccessRequest $Result
New-AccessRequest -AccessRequest $Result
# Below is a request that includes all optional parameters
# New-AccessRequest -AccessRequest $AccessRequest
@@ -373,7 +372,7 @@ $AccessRequestConfig = @"{
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig
Set-AccessRequestConfig-AccessRequestConfig $Result
Set-AccessRequestConfig -AccessRequestConfig $Result
# Below is a request that includes all optional parameters
# Set-AccessRequestConfig -AccessRequestConfig $AccessRequestConfig

3
docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md
View File

@@ -1,4 +1,3 @@
---
id: account-activities
title: AccountActivities
@@ -87,7 +86,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id
# Get an Account Activity
try {
Get-AccountActivity-Id $Id
Get-AccountActivity -Id $Id
# Below is a request that includes all optional parameters
# Get-AccountActivity -Id $Id

3
docs/tools/sdk/powershell/Reference/V3/Methods/AccountUsagesApi.md
View File

@@ -1,4 +1,3 @@
---
id: account-usages
title: AccountUsages
@@ -63,7 +62,7 @@ $Sorters = "-date" # String | Sort results using the standard syntax described i
# Returns account usage insights
try {
Get-UsagesByAccountId-AccountId $AccountId
Get-UsagesByAccountId -AccountId $AccountId
# Below is a request that includes all optional parameters
# Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters

21
docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md
View File

@@ -1,4 +1,3 @@
---
id: accounts
title: Accounts
@@ -110,7 +109,7 @@ $AccountAttributesCreate = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
New-Account-AccountAttributesCreate $Result
New-Account -AccountAttributesCreate $Result
# Below is a request that includes all optional parameters
# New-Account -AccountAttributesCreate $AccountAttributesCreate
@@ -156,7 +155,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Delete Account
try {
Remove-Account-Id $Id
Remove-Account -Id $Id
# Below is a request that includes all optional parameters
# Remove-Account -Id $Id
@@ -205,7 +204,7 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Disable-Account-Id $Id -AccountToggleRequest $Result
Disable-Account -Id $Id -AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Disable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest
@@ -254,7 +253,7 @@ $AccountToggleRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Enable-Account-Id $Id -AccountToggleRequest $Result
Enable-Account -Id $Id -AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Enable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest
@@ -297,7 +296,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Account Details
try {
Get-Account-Id $Id
Get-Account -Id $Id
# Below is a request that includes all optional parameters
# Get-Account -Id $Id
@@ -346,7 +345,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Account Entitlements
try {
Get-AccountEntitlements-Id $Id
Get-AccountEntitlements -Id $Id
# Below is a request that includes all optional parameters
# Get-AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count
@@ -457,7 +456,7 @@ $AccountAttributes = @"{
try {
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
Send-Account-Id $Id -AccountAttributes $Result
Send-Account -Id $Id -AccountAttributes $Result
# Below is a request that includes all optional parameters
# Send-Account -Id $Id -AccountAttributes $AccountAttributes
@@ -500,7 +499,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
# Reload Account
try {
Submit-ReloadAccount-Id $Id
Submit-ReloadAccount -Id $Id
# Below is a request that includes all optional parameters
# Submit-ReloadAccount -Id $Id
@@ -551,7 +550,7 @@ $AccountUnlockRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
Unlock-Account-Id $Id -AccountUnlockRequest $Result
Unlock-Account -Id $Id -AccountUnlockRequest $Result
# Below is a request that includes all optional parameters
# Unlock-Account -Id $Id -AccountUnlockRequest $AccountUnlockRequest
@@ -609,7 +608,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-Account-Id $Id -RequestBody $Result
Update-Account -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-Account -Id $Id -RequestBody $RequestBody

3
docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md
View File

@@ -1,4 +1,3 @@
---
id: application-discovery
title: ApplicationDiscovery
@@ -151,7 +150,7 @@ $File = # System.IO.FileInfo | The CSV file to upload containing `application_n
# Upload CSV to Discover Applications
try {
Send-ManualDiscoverApplicationsCsvTemplate-File $File
Send-ManualDiscoverApplicationsCsvTemplate -File $File
# Below is a request that includes all optional parameters
# Send-ManualDiscoverApplicationsCsvTemplate -File $File

5
docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md
View File

@@ -1,4 +1,3 @@
---
id: auth-users
title: AuthUsers
@@ -59,7 +58,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
# Auth User Details
try {
Get-AuthUser-Id $Id
Get-AuthUser -Id $Id
# Below is a request that includes all optional parameters
# Get-AuthUser -Id $Id
@@ -114,7 +113,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthUser-Id $Id -JsonPatchOperation $Result
Update-AuthUser -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthUser -Id $Id -JsonPatchOperation $JsonPatchOperation

9
docs/tools/sdk/powershell/Reference/V3/Methods/BrandingApi.md
View File

@@ -1,4 +1,3 @@
---
id: branding
title: Branding
@@ -75,7 +74,7 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional)
# Create a branding item
try {
New-BrandingItem-Name $Name -ProductName $ProductName
New-BrandingItem -Name $Name -ProductName $ProductName
# Below is a request that includes all optional parameters
# New-BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard
@@ -118,7 +117,7 @@ $Name = "default" # String | The name of the branding item to be deleted
# Delete a branding item
try {
Remove-Branding-Name $Name
Remove-Branding -Name $Name
# Below is a request that includes all optional parameters
# Remove-Branding -Name $Name
@@ -161,7 +160,7 @@ $Name = "default" # String | The name of the branding item to be retrieved
# Get a branding item
try {
Get-Branding-Name $Name
Get-Branding -Name $Name
# Below is a request that includes all optional parameters
# Get-Branding -Name $Name
@@ -260,7 +259,7 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional)
# Update a branding item
try {
Set-BrandingItem-Name $Name -Name2 $Name2 -ProductName $ProductName
Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName
# Below is a request that includes all optional parameters
# Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard

9
docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md
View File

@@ -1,4 +1,3 @@
---
id: certification-campaign-filters
title: CertificationCampaignFilters
@@ -101,7 +100,7 @@ $CampaignFilterDetails = @"{
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
New-CampaignFilter-CampaignFilterDetails $Result
New-CampaignFilter -CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# New-CampaignFilter -CampaignFilterDetails $CampaignFilterDetails
@@ -147,7 +146,7 @@ $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filte
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-CampaignFilters-RequestBody $Result
Remove-CampaignFilters -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-CampaignFilters -RequestBody $RequestBody
@@ -190,7 +189,7 @@ $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filte
# Get Campaign Filter by ID
try {
Get-CampaignFilterById-Id $Id
Get-CampaignFilterById -Id $Id
# Below is a request that includes all optional parameters
# Get-CampaignFilterById -Id $Id
@@ -298,7 +297,7 @@ $CampaignFilterDetails = @"{
try {
$Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails
Update-CampaignFilter-FilterId $FilterId -CampaignFilterDetails $Result
Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $CampaignFilterDetails

39
docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md
View File

@@ -1,4 +1,3 @@
---
id: certification-campaigns
title: CertificationCampaigns
@@ -153,7 +152,7 @@ $CampaignCompleteOptions = @"{
# Complete a Campaign
try {
Complete-Campaign-Id $Id
Complete-Campaign -Id $Id
# Below is a request that includes all optional parameters
# Complete-Campaign -Id $Id -CampaignCompleteOptions $CampaignCompleteOptions
@@ -305,7 +304,7 @@ $Campaign = @"{
try {
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
New-Campaign-Campaign $Result
New-Campaign -Campaign $Result
# Below is a request that includes all optional parameters
# New-Campaign -Campaign $Campaign
@@ -472,7 +471,7 @@ $CampaignTemplate = @"{
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
New-CampaignTemplate-CampaignTemplate $Result
New-CampaignTemplate -CampaignTemplate $Result
# Below is a request that includes all optional parameters
# New-CampaignTemplate -CampaignTemplate $CampaignTemplate
@@ -516,7 +515,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
# Delete a Campaign Template
try {
Remove-CampaignTemplate-Id $Id
Remove-CampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Remove-CampaignTemplate -Id $Id
@@ -560,7 +559,7 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template
# Delete Campaign Template Schedule
try {
Remove-CampaignTemplateSchedule-Id $Id
Remove-CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Remove-CampaignTemplateSchedule -Id $Id
@@ -607,7 +606,7 @@ $CampaignsDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest
Remove-Campaigns-CampaignsDeleteRequest $Result
Remove-Campaigns -CampaignsDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-Campaigns -CampaignsDeleteRequest $CampaignsDeleteRequest
@@ -706,7 +705,7 @@ $Detail = "SLIM" # String | Determines whether slim, or increased level of detai
# Get Campaign
try {
Get-Campaign-Id $Id
Get-Campaign -Id $Id
# Below is a request that includes all optional parameters
# Get-Campaign -Id $Id -Detail $Detail
@@ -750,7 +749,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose rep
# Get Campaign Reports
try {
Get-CampaignReports-Id $Id
Get-CampaignReports -Id $Id
# Below is a request that includes all optional parameters
# Get-CampaignReports -Id $Id
@@ -835,7 +834,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template'
# Get a Campaign Template
try {
Get-CampaignTemplate-Id $Id
Get-CampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Get-CampaignTemplate -Id $Id
@@ -879,7 +878,7 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template
# Get Campaign Template Schedule
try {
Get-CampaignTemplateSchedule-Id $Id
Get-CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Get-CampaignTemplateSchedule -Id $Id
@@ -986,7 +985,7 @@ $AdminReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
Move--Id $Id -AdminReviewReassign $Result
Move- -Id $Id -AdminReviewReassign $Result
# Below is a request that includes all optional parameters
# Move- -Id $Id -AdminReviewReassign $AdminReviewReassign
@@ -1038,7 +1037,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-CampaignTemplate-Id $Id -JsonPatchOperation $Result
Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-CampaignTemplate -Id $Id -JsonPatchOperation $JsonPatchOperation
@@ -1084,7 +1083,7 @@ $CampaignReportsConfig = @"{
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
Set-CampaignReportsConfig-CampaignReportsConfig $Result
Set-CampaignReportsConfig -CampaignReportsConfig $Result
# Below is a request that includes all optional parameters
# Set-CampaignReportsConfig -CampaignReportsConfig $CampaignReportsConfig
@@ -1149,7 +1148,7 @@ $Schedule = @"{
# Set Campaign Template Schedule
try {
Set-CampaignTemplateSchedule-Id $Id
Set-CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Set-CampaignTemplateSchedule -Id $Id -Schedule $Schedule
@@ -1197,7 +1196,7 @@ $ActivateCampaignOptions = @"{
# Activate a Campaign
try {
Start-Campaign-Id $Id
Start-Campaign -Id $Id
# Below is a request that includes all optional parameters
# Start-Campaign -Id $Id -ActivateCampaignOptions $ActivateCampaignOptions
@@ -1241,7 +1240,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remed
# Run Campaign Remediation Scan
try {
Start-CampaignRemediationScan-Id $Id
Start-CampaignRemediationScan -Id $Id
# Below is a request that includes all optional parameters
# Start-CampaignRemediationScan -Id $Id
@@ -1287,7 +1286,7 @@ $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run.
# Run Campaign Report
try {
Start-CampaignReport-Id $Id -Type $Type
Start-CampaignReport -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Start-CampaignReport -Id $Id -Type $Type
@@ -1340,7 +1339,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
# Generate a Campaign from Template
try {
Start-GenerateCampaignTemplate-Id $Id
Start-GenerateCampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Start-GenerateCampaignTemplate -Id $Id
@@ -1392,7 +1391,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Campaign-Id $Id -JsonPatchOperation $Result
Update-Campaign -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Campaign -Id $Id -JsonPatchOperation $JsonPatchOperation

9
docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md
View File

@@ -1,4 +1,3 @@
---
id: certification-summaries
title: CertificationSummaries
@@ -82,7 +81,7 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr
# Access Summaries
try {
Get-IdentityAccessSummaries-Id $Id -Type $Type
Get-IdentityAccessSummaries -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -127,7 +126,7 @@ $Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String |
# Summary of Certification Decisions
try {
Get-IdentityDecisionSummary-Id $Id
Get-IdentityDecisionSummary -Id $Id
# Below is a request that includes all optional parameters
# Get-IdentityDecisionSummary -Id $Id -Filters $Filters
@@ -180,7 +179,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# Identity Summaries for Campaign Certification
try {
Get-IdentitySummaries-Id $Id
Get-IdentitySummaries -Id $Id
# Below is a request that includes all optional parameters
# Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -225,7 +224,7 @@ $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity
# Summary for Identity
try {
Get-IdentitySummary-Id $Id -IdentitySummaryId $IdentitySummaryId
Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId
# Below is a request that includes all optional parameters
# Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId

19
docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md
View File

@@ -1,4 +1,3 @@
---
id: certifications
title: Certifications
@@ -86,7 +85,7 @@ $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID
# Certification Task by ID
try {
Get-CertificationTask-Id $Id
Get-CertificationTask -Id $Id
# Below is a request that includes all optional parameters
# Get-CertificationTask -Id $Id
@@ -129,7 +128,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id
# Identity Certification by ID
try {
Get-IdentityCertification-Id $Id
Get-IdentityCertification -Id $Id
# Below is a request that includes all optional parameters
# Get-IdentityCertification -Id $Id
@@ -182,7 +181,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# Permissions for Entitlement Certification Item
try {
Get-IdentityCertificationItemPermissions-CertificationId $CertificationId -ItemId $ItemId
Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId
# Below is a request that includes all optional parameters
# Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count
@@ -286,7 +285,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
# List of Reviewers for certification
try {
Get-CertificationReviewers-Id $Id
Get-CertificationReviewers -Id $Id
# Below is a request that includes all optional parameters
# Get-CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -345,7 +344,7 @@ $Roles = "userRole" # String | Filter results to view access review items that p
# List of Access Review Items
try {
Get-IdentityAccessReviewItems-Id $Id
Get-IdentityAccessReviewItems -Id $Id
# Below is a request that includes all optional parameters
# Get-IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles
@@ -455,7 +454,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa
try {
$Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision
Select-IdentityDecision-Id $Id -ReviewDecision $Result
Select-IdentityDecision -Id $Id -ReviewDecision $Result
# Below is a request that includes all optional parameters
# Select-IdentityDecision -Id $Id -ReviewDecision $ReviewDecision
@@ -511,7 +510,7 @@ $ReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Invoke-ReassignIdentityCertifications-Id $Id -ReviewReassign $Result
Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result
# Below is a request that includes all optional parameters
# Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $ReviewReassign
@@ -554,7 +553,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certif
# Finalize Identity Certification Decisions
try {
Invoke-SignOffIdentityCertification-Id $Id
Invoke-SignOffIdentityCertification -Id $Id
# Below is a request that includes all optional parameters
# Invoke-SignOffIdentityCertification -Id $Id
@@ -615,7 +614,7 @@ $ReviewReassign = @"{
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign
Submit-ReassignCertsAsync-Id $Id -ReviewReassign $Result
Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result
# Below is a request that includes all optional parameters
# Submit-ReassignCertsAsync -Id $Id -ReviewReassign $ReviewReassign

17
docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md
View File

@@ -1,4 +1,3 @@
---
id: configuration-hub
title: ConfigurationHub
@@ -82,7 +81,7 @@ $ObjectMappingRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest
New-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingRequest $Result
New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result
# Below is a request that includes all optional parameters
# New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $ObjectMappingRequest
@@ -145,7 +144,7 @@ $ObjectMappingBulkCreateRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest
New-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
# Below is a request that includes all optional parameters
# New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest
@@ -193,7 +192,7 @@ $Name = "MyName" # String | Name that will be assigned to the uploaded configura
# Upload a Configuration
try {
New-UploadedConfiguration-Data $Data -Name $Name
New-UploadedConfiguration -Data $Data -Name $Name
# Below is a request that includes all optional parameters
# New-UploadedConfiguration -Data $Data -Name $Name
@@ -241,7 +240,7 @@ $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of t
# Deletes an object mapping
try {
Remove-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
# Below is a request that includes all optional parameters
# Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
@@ -288,7 +287,7 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded c
# Delete an Uploaded Configuration
try {
Remove-UploadedConfiguration-Id $Id
Remove-UploadedConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Remove-UploadedConfiguration -Id $Id
@@ -334,7 +333,7 @@ $SourceOrg = "source-org" # String | The name of the source org.
# Gets list of object mappings
try {
Get-ObjectMappings-SourceOrg $SourceOrg
Get-ObjectMappings -SourceOrg $SourceOrg
# Below is a request that includes all optional parameters
# Get-ObjectMappings -SourceOrg $SourceOrg
@@ -377,7 +376,7 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded c
# Get an Uploaded Configuration
try {
Get-UploadedConfiguration-Id $Id
Get-UploadedConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Get-UploadedConfiguration -Id $Id
@@ -482,7 +481,7 @@ $ObjectMappingBulkPatchRequest = @"{
try {
$Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest
Update-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
# Below is a request that includes all optional parameters
# Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest

21
docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md
View File

@@ -1,4 +1,3 @@
---
id: connectors
title: Connectors
@@ -84,7 +83,7 @@ $V3CreateConnectorDto = @"{
try {
$Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto
New-CustomConnector-V3CreateConnectorDto $Result
New-CustomConnector -V3CreateConnectorDto $Result
# Below is a request that includes all optional parameters
# New-CustomConnector -V3CreateConnectorDto $V3CreateConnectorDto
@@ -127,7 +126,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Delete Connector by Script Name
try {
Remove-CustomConnector-ScriptName $ScriptName
Remove-CustomConnector -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Remove-CustomConnector -ScriptName $ScriptName
@@ -172,7 +171,7 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector by Script Name
try {
Get-Connector-ScriptName $ScriptName
Get-Connector -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-Connector -ScriptName $ScriptName -Locale $Locale
@@ -266,7 +265,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Get Connector Source Configuration
try {
Get-ConnectorSourceConfig-ScriptName $ScriptName
Get-ConnectorSourceConfig -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-ConnectorSourceConfig -ScriptName $ScriptName
@@ -309,7 +308,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
# Get Connector Source Template
try {
Get-ConnectorSourceTemplate-ScriptName $ScriptName
Get-ConnectorSourceTemplate -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-ConnectorSourceTemplate -ScriptName $ScriptName
@@ -354,7 +353,7 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Get Connector Translations
try {
Get-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale
Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
@@ -399,7 +398,7 @@ $File = # System.IO.FileInfo | connector source config xml file
# Update Connector Source Configuration
try {
Send-ConnectorSourceConfig-ScriptName $ScriptName -File $File
Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File
@@ -444,7 +443,7 @@ $File = # System.IO.FileInfo | connector source template xml file
# Update Connector Source Template
try {
Send-ConnectorSourceTemplate-ScriptName $ScriptName -File $File
Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File
@@ -489,7 +488,7 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale
# Update Connector Translations
try {
Send-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale
Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale
@@ -552,7 +551,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Connector-ScriptName $ScriptName -JsonPatchOperation $Result
Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Connector -ScriptName $ScriptName -JsonPatchOperation $JsonPatchOperation

11
docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md
View File

@@ -1,4 +1,3 @@
---
id: global-tenant-security-settings
title: GlobalTenantSecuritySettings
@@ -69,7 +68,7 @@ $NetworkConfiguration = @"{
try {
$Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration
New-AuthOrgNetworkConfig-NetworkConfiguration $Result
New-AuthOrgNetworkConfig -NetworkConfiguration $Result
# Below is a request that includes all optional parameters
# New-AuthOrgNetworkConfig -NetworkConfiguration $NetworkConfiguration
@@ -283,7 +282,7 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgLockoutConfig-JsonPatchOperation $Result
Update-AuthOrgLockoutConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgLockoutConfig -JsonPatchOperation $JsonPatchOperation
@@ -333,7 +332,7 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgNetworkConfig-JsonPatchOperation $Result
Update-AuthOrgNetworkConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgNetworkConfig -JsonPatchOperation $JsonPatchOperation
@@ -382,7 +381,7 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgServiceProviderConfig-JsonPatchOperation $Result
Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgServiceProviderConfig -JsonPatchOperation $JsonPatchOperation
@@ -431,7 +430,7 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-AuthOrgSessionConfig-JsonPatchOperation $Result
Update-AuthOrgSessionConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-AuthOrgSessionConfig -JsonPatchOperation $JsonPatchOperation

19
docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md
View File

@@ -1,4 +1,3 @@
---
id: identity-profiles
title: IdentityProfiles
@@ -121,7 +120,7 @@ $IdentityProfile = @"{
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
New-IdentityProfile-IdentityProfile $Result
New-IdentityProfile -IdentityProfile $Result
# Below is a request that includes all optional parameters
# New-IdentityProfile -IdentityProfile $IdentityProfile
@@ -169,7 +168,7 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
# Delete an Identity Profile
try {
Remove-IdentityProfile-IdentityProfileId $IdentityProfileId
Remove-IdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Remove-IdentityProfile -IdentityProfileId $IdentityProfileId
@@ -218,7 +217,7 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-IdentityProfiles-RequestBody $Result
Remove-IdentityProfiles -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-IdentityProfiles -RequestBody $RequestBody
@@ -311,7 +310,7 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Ident
# Get default Identity Attribute Config
try {
Get-DefaultIdentityAttributeConfig-IdentityProfileId $IdentityProfileId
Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId
@@ -354,7 +353,7 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Ident
# Get single Identity Profile
try {
Get-IdentityProfile-IdentityProfileId $IdentityProfileId
Get-IdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-IdentityProfile -IdentityProfileId $IdentityProfileId
@@ -459,7 +458,7 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject
Import-IdentityProfiles-IdentityProfileExportedObject $Result
Import-IdentityProfiles -IdentityProfileExportedObject $Result
# Below is a request that includes all optional parameters
# Import-IdentityProfiles -IdentityProfileExportedObject $IdentityProfileExportedObject
@@ -579,7 +578,7 @@ $IdentityPreviewRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
Show-IdentityPreview-IdentityPreviewRequest $Result
Show-IdentityPreview -IdentityPreviewRequest $Result
# Below is a request that includes all optional parameters
# Show-IdentityPreview -IdentityPreviewRequest $IdentityPreviewRequest
@@ -626,7 +625,7 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
# Process identities under profile
try {
Sync-IdentityProfile-IdentityProfileId $IdentityProfileId
Sync-IdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Sync-IdentityProfile -IdentityProfileId $IdentityProfileId
@@ -687,7 +686,7 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-IdentityProfile-IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $JsonPatchOperation

13
docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md
View File

@@ -1,4 +1,3 @@
---
id: lifecycle-states
title: LifecycleStates
@@ -122,7 +121,7 @@ $LifecycleState = @"{
try {
$Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState
New-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleState $Result
New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result
# Below is a request that includes all optional parameters
# New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $LifecycleState
@@ -167,7 +166,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
# Delete Lifecycle State
try {
Remove-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
# Below is a request that includes all optional parameters
# Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
@@ -212,7 +211,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
# Get Lifecycle State
try {
Get-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
# Below is a request that includes all optional parameters
# Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
@@ -262,7 +261,7 @@ $Sorters = "created,modified" # String | Sort results using the standard syntax
# Lists LifecycleStates
try {
Get-LifecycleStates-IdentityProfileId $IdentityProfileId
Get-LifecycleStates -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
@@ -308,7 +307,7 @@ $SetLifecycleStateRequest = @""@
try {
$Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest
Set-LifecycleState-IdentityId $IdentityId -SetLifecycleStateRequest $Result
Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result
# Below is a request that includes all optional parameters
# Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $SetLifecycleStateRequest
@@ -361,7 +360,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-LifecycleStates-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $JsonPatchOperation

11
docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md
View File

@@ -1,4 +1,3 @@
---
id: mfa-configuration
title: MFAConfiguration
@@ -59,7 +58,7 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup
# Delete MFA method configuration
try {
Remove-MFAConfig-Method $Method
Remove-MFAConfig -Method $Method
# Below is a request that includes all optional parameters
# Remove-MFAConfig -Method $Method
@@ -234,7 +233,7 @@ $MfaDuoConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
Set-MFADuoConfig-MfaDuoConfig $Result
Set-MFADuoConfig -MfaDuoConfig $Result
# Below is a request that includes all optional parameters
# Set-MFADuoConfig -MfaDuoConfig $MfaDuoConfig
@@ -281,7 +280,7 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Set-MFAKBAConfig-KbaAnswerRequestItem $Result
Set-MFAKBAConfig -KbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Set-MFAKBAConfig -KbaAnswerRequestItem $KbaAnswerRequestItem
@@ -330,7 +329,7 @@ $MfaOktaConfig = @"{
try {
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
Set-MFAOktaConfig-MfaOktaConfig $Result
Set-MFAOktaConfig -MfaOktaConfig $Result
# Below is a request that includes all optional parameters
# Set-MFAOktaConfig -MfaOktaConfig $MfaOktaConfig
@@ -372,7 +371,7 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup
# MFA method's test configuration
try {
Test-MFAConfig-Method $Method
Test-MFAConfig -Method $Method
# Below is a request that includes all optional parameters
# Test-MFAConfig -Method $Method

13
docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md
View File

@@ -1,4 +1,3 @@
---
id: mfa-controller
title: MFAController
@@ -61,7 +60,7 @@ $SendTokenRequest = @"{
try {
$Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest
New-SendToken-SendTokenRequest $Result
New-SendToken -SendTokenRequest $Result
# Below is a request that includes all optional parameters
# New-SendToken -SendTokenRequest $SendTokenRequest
@@ -108,7 +107,7 @@ $VerificationPollRequest = @"{
try {
$Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest
Ping-VerificationStatus-Method $Method -VerificationPollRequest $Result
Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result
# Below is a request that includes all optional parameters
# Ping-VerificationStatus -Method $Method -VerificationPollRequest $VerificationPollRequest
@@ -154,7 +153,7 @@ $DuoVerificationRequest = @"{
try {
$Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest
Send-DuoVerifyRequest-DuoVerificationRequest $Result
Send-DuoVerifyRequest -DuoVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-DuoVerifyRequest -DuoVerificationRequest $DuoVerificationRequest
@@ -201,7 +200,7 @@ Code | Description | Data Type
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Send-KbaAnswers-KbaAnswerRequestItem $Result
Send-KbaAnswers -KbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Send-KbaAnswers -KbaAnswerRequestItem $KbaAnswerRequestItem
@@ -246,7 +245,7 @@ $OktaVerificationRequest = @"{
try {
$Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest
Send-OktaVerifyRequest-OktaVerificationRequest $Result
Send-OktaVerifyRequest -OktaVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-OktaVerifyRequest -OktaVerificationRequest $OktaVerificationRequest
@@ -293,7 +292,7 @@ $TokenAuthRequest = @"{
try {
$Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest
Send-TokenAuthRequest-TokenAuthRequest $Result
Send-TokenAuthRequest -TokenAuthRequest $Result
# Below is a request that includes all optional parameters
# Send-TokenAuthRequest -TokenAuthRequest $TokenAuthRequest

11
docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md
View File

@@ -1,4 +1,3 @@
---
id: managed-clients
title: ManagedClients
@@ -66,7 +65,7 @@ $ManagedClientRequest = @"{
try {
$Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest
New-ManagedClient-ManagedClientRequest $Result
New-ManagedClient -ManagedClientRequest $Result
# Below is a request that includes all optional parameters
# New-ManagedClient -ManagedClientRequest $ManagedClientRequest
@@ -108,7 +107,7 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Delete Managed Client
try {
Remove-ManagedClient-Id $Id
Remove-ManagedClient -Id $Id
# Below is a request that includes all optional parameters
# Remove-ManagedClient -Id $Id
@@ -151,7 +150,7 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Get Managed Client
try {
Get-ManagedClient-Id $Id
Get-ManagedClient -Id $Id
# Below is a request that includes all optional parameters
# Get-ManagedClient -Id $Id
@@ -196,7 +195,7 @@ $Type = "CCG" # ManagedClientType | Managed client type to get status for.
# Get Managed Client Status
try {
Get-ManagedClientStatus-Id $Id -Type $Type
Get-ManagedClientStatus -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Get-ManagedClientStatus -Id $Id -Type $Type
@@ -295,7 +294,7 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-ManagedClient-Id $Id -JsonPatchOperation $Result
Update-ManagedClient -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-ManagedClient -Id $Id -JsonPatchOperation $JsonPatchOperation

13
docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md
View File

@@ -1,4 +1,3 @@
---
id: managed-clusters
title: ManagedClusters
@@ -70,7 +69,7 @@ $ManagedClusterRequest = @"{
try {
$Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest
New-ManagedCluster-ManagedClusterRequest $Result
New-ManagedCluster -ManagedClusterRequest $Result
# Below is a request that includes all optional parameters
# New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest
@@ -114,7 +113,7 @@ $RemoveClients = $false # Boolean | Flag to determine the need to delete a clust
# Delete Managed Cluster
try {
Remove-ManagedCluster-Id $Id
Remove-ManagedCluster -Id $Id
# Below is a request that includes all optional parameters
# Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients
@@ -158,7 +157,7 @@ $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to
# Get Managed Cluster Log Configuration
try {
Get-ClientLogConfiguration-Id $Id
Get-ClientLogConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Get-ClientLogConfiguration -Id $Id
@@ -201,7 +200,7 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
# Get Managed Cluster
try {
Get-ManagedCluster-Id $Id
Get-ManagedCluster -Id $Id
# Below is a request that includes all optional parameters
# Get-ManagedCluster -Id $Id
@@ -295,7 +294,7 @@ $PutClientLogConfigurationRequest = @""@
try {
$Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest
Send-ClientLogConfiguration-Id $Id -PutClientLogConfigurationRequest $Result
Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest
@@ -346,7 +345,7 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-ManagedCluster-Id $Id -JsonPatchOperation $Result
Update-ManagedCluster -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation

61
docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md
View File

@@ -1,4 +1,3 @@
---
id: non-employee-lifecycle-management
title: NonEmployeeLifecycleManagement
@@ -119,7 +118,7 @@ $NonEmployeeApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
Approve-NonEmployeeRequest-Id $Id -NonEmployeeApprovalDecision $Result
Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
# Below is a request that includes all optional parameters
# Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $NonEmployeeApprovalDecision
@@ -176,7 +175,7 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-NonEmployeeRecord-NonEmployeeRequestBody $Result
New-NonEmployeeRecord -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeRecord -NonEmployeeRequestBody $NonEmployeeRequestBody
@@ -232,7 +231,7 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
New-NonEmployeeRequest-NonEmployeeRequestBody $Result
New-NonEmployeeRequest -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeRequest -NonEmployeeRequestBody $NonEmployeeRequestBody
@@ -300,7 +299,7 @@ $NonEmployeeSourceRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
New-NonEmployeeSource-NonEmployeeSourceRequestBody $Result
New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeSource -NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody
@@ -353,7 +352,7 @@ $NonEmployeeSchemaAttributeBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
New-NonEmployeeSourceSchemaAttributes-SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
# Below is a request that includes all optional parameters
# New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody
@@ -396,7 +395,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID
# Delete Non-Employee Record
try {
Remove-NonEmployeeRecord-Id $Id
Remove-NonEmployeeRecord -Id $Id
# Below is a request that includes all optional parameters
# Remove-NonEmployeeRecord -Id $Id
@@ -439,7 +438,7 @@ $DeleteNonEmployeeRecordsInBulkRequest = @""@
try {
$Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest
Remove-NonEmployeeRecordsInBulk-DeleteNonEmployeeRecordsInBulkRequest $Result
Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
# Below is a request that includes all optional parameters
# Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest
@@ -483,7 +482,7 @@ $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id
# Delete Non-Employee Request
try {
Remove-NonEmployeeRequest-Id $Id
Remove-NonEmployeeRequest -Id $Id
# Below is a request that includes all optional parameters
# Remove-NonEmployeeRequest -Id $Id
@@ -529,7 +528,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Delete a Schema Attribute for Non-Employee Source
try {
Remove-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId
Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -571,7 +570,7 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
# Delete Non-Employee Source
try {
Remove-NonEmployeeSource-SourceId $SourceId
Remove-NonEmployeeSource -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-NonEmployeeSource -SourceId $SourceId
@@ -613,7 +612,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Delete all custom schema attributes for Non-Employee Source
try {
Remove-NonEmployeeSourceSchemaAttributes-SourceId $SourceId
Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId
@@ -656,7 +655,7 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
# Exports Non-Employee Records to CSV
try {
Export-NonEmployeeRecords-Id $Id
Export-NonEmployeeRecords -Id $Id
# Below is a request that includes all optional parameters
# Export-NonEmployeeRecords -Id $Id
@@ -699,7 +698,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID)
# Exports Source Schema Template
try {
Export-NonEmployeeSourceSchemaTemplate-Id $Id
Export-NonEmployeeSourceSchemaTemplate -Id $Id
# Below is a request that includes all optional parameters
# Export-NonEmployeeSourceSchemaTemplate -Id $Id
@@ -746,7 +745,7 @@ $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be inc
# Get a non-employee approval item detail
try {
Get-NonEmployeeApproval-Id $Id
Get-NonEmployeeApproval -Id $Id
# Below is a request that includes all optional parameters
# Get-NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail
@@ -792,7 +791,7 @@ $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID
# Get Summary of Non-Employee Approval Requests
try {
Get-NonEmployeeApprovalSummary-RequestedFor $RequestedFor
Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor
@@ -836,7 +835,7 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID)
# Obtain the status of bulk upload on the source
try {
Get-NonEmployeeBulkUploadStatus-Id $Id
Get-NonEmployeeBulkUploadStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-NonEmployeeBulkUploadStatus -Id $Id
@@ -879,7 +878,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID
# Get a Non-Employee Record
try {
Get-NonEmployeeRecord-Id $Id
Get-NonEmployeeRecord -Id $Id
# Below is a request that includes all optional parameters
# Get-NonEmployeeRecord -Id $Id
@@ -926,7 +925,7 @@ $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id
# Get a Non-Employee Request
try {
Get-NonEmployeeRequest-Id $Id
Get-NonEmployeeRequest -Id $Id
# Below is a request that includes all optional parameters
# Get-NonEmployeeRequest -Id $Id
@@ -972,7 +971,7 @@ $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID
# Get Summary of Non-Employee Requests
try {
Get-NonEmployeeRequestSummary-RequestedFor $RequestedFor
Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor
@@ -1016,7 +1015,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Get Schema Attribute Non-Employee Source
try {
Get-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId
Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -1062,7 +1061,7 @@ $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id
# Get a Non-Employee Source
try {
Get-NonEmployeeSource-SourceId $SourceId
Get-NonEmployeeSource -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-NonEmployeeSource -SourceId $SourceId
@@ -1106,7 +1105,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# List Schema Attributes Non-Employee Source
try {
Get-NonEmployeeSourceSchemaAttributes-SourceId $SourceId
Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId
@@ -1151,7 +1150,7 @@ $Data = # System.IO.FileInfo |
# Imports, or Updates, Non-Employee Records
try {
Import-NonEmployeeRecordsInBulk-Id $Id -Data $Data
Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data
# Below is a request that includes all optional parameters
# Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data
@@ -1315,7 +1314,7 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re
# List Non-Employee Requests
try {
Get-NonEmployeeRequests-RequestedFor $RequestedFor
Get-NonEmployeeRequests -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters
@@ -1371,7 +1370,7 @@ $Sorters = "name,created" # String | Sort results using the standard syntax desc
# List Non-Employee Sources
try {
Get-NonEmployeeSources-RequestedFor $RequestedFor
Get-NonEmployeeSources -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters
@@ -1426,7 +1425,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-NonEmployeeRecord-Id $Id -JsonPatchOperation $Result
Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $JsonPatchOperation
@@ -1481,7 +1480,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation
@@ -1531,7 +1530,7 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-NonEmployeeSource-SourceId $SourceId -JsonPatchOperation $Result
Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation
@@ -1578,7 +1577,7 @@ $NonEmployeeRejectApprovalDecision = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
Deny-NonEmployeeRequest-Id $Id -NonEmployeeRejectApprovalDecision $Result
Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
# Below is a request that includes all optional parameters
# Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision
@@ -1641,7 +1640,7 @@ $NonEmployeeRequestBody = @"{
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
Update-NonEmployeeRecord-Id $Id -NonEmployeeRequestBody $Result
Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $NonEmployeeRequestBody

9
docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md
View File

@@ -1,4 +1,3 @@
---
id: o-auth-clients
title: OAuthClients
@@ -76,7 +75,7 @@ $CreateOAuthClientRequest = @"{
try {
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
New-OauthClient-CreateOAuthClientRequest $Result
New-OauthClient -CreateOAuthClientRequest $Result
# Below is a request that includes all optional parameters
# New-OauthClient -CreateOAuthClientRequest $CreateOAuthClientRequest
@@ -119,7 +118,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Delete OAuth Client
try {
Remove-OauthClient-Id $Id
Remove-OauthClient -Id $Id
# Below is a request that includes all optional parameters
# Remove-OauthClient -Id $Id
@@ -162,7 +161,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Get OAuth Client
try {
Get-OauthClient-Id $Id
Get-OauthClient -Id $Id
# Below is a request that includes all optional parameters
# Get-OauthClient -Id $Id
@@ -255,7 +254,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-OauthClient-Id $Id -JsonPatchOperation $Result
Update-OauthClient -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-OauthClient -Id $Id -JsonPatchOperation $JsonPatchOperation

5
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md
View File

@@ -1,4 +1,3 @@
---
id: password-configuration
title: PasswordConfiguration
@@ -68,7 +67,7 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
New-PasswordOrgConfig-PasswordOrgConfig $Result
New-PasswordOrgConfig -PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# New-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig
@@ -158,7 +157,7 @@ $PasswordOrgConfig = @"{
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
Send-PasswordOrgConfig-PasswordOrgConfig $Result
Send-PasswordOrgConfig -PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# Send-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig

1
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md
View File

@@ -1,4 +1,3 @@
---
id: password-dictionary
title: PasswordDictionary

7
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md
View File

@@ -1,4 +1,3 @@
---
id: password-management
title: PasswordManagement
@@ -79,7 +78,7 @@ $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID
# Get Password Change Request Status
try {
Get-PasswordChangeStatus-Id $Id
Get-PasswordChangeStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-PasswordChangeStatus -Id $Id
@@ -126,7 +125,7 @@ $PasswordInfoQueryDTO = @"{
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
Search-PasswordInfo-PasswordInfoQueryDTO $Result
Search-PasswordInfo -PasswordInfoQueryDTO $Result
# Below is a request that includes all optional parameters
# Search-PasswordInfo -PasswordInfoQueryDTO $PasswordInfoQueryDTO
@@ -194,7 +193,7 @@ $PasswordChangeRequest = @"{
try {
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest
Set-Password-PasswordChangeRequest $Result
Set-Password -PasswordChangeRequest $Result
# Below is a request that includes all optional parameters
# Set-Password -PasswordChangeRequest $PasswordChangeRequest

9
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md
View File

@@ -1,4 +1,3 @@
---
id: password-policies
title: PasswordPolicies
@@ -98,7 +97,7 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
New-PasswordPolicy-PasswordPolicyV3Dto $Result
New-PasswordPolicy -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# New-PasswordPolicy -PasswordPolicyV3Dto $PasswordPolicyV3Dto
@@ -141,7 +140,7 @@ $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to
# Delete Password Policy by ID
try {
Remove-PasswordPolicy-Id $Id
Remove-PasswordPolicy -Id $Id
# Below is a request that includes all optional parameters
# Remove-PasswordPolicy -Id $Id
@@ -184,7 +183,7 @@ $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to
# Get Password Policy by ID
try {
Get-PasswordPolicyById-Id $Id
Get-PasswordPolicyById -Id $Id
# Below is a request that includes all optional parameters
# Get-PasswordPolicyById -Id $Id
@@ -309,7 +308,7 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
Set-PasswordPolicy-Id $Id -PasswordPolicyV3Dto $Result
Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $PasswordPolicyV3Dto

9
docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md
View File

@@ -1,4 +1,3 @@
---
id: password-sync-groups
title: PasswordSyncGroups
@@ -96,7 +95,7 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
New-PasswordSyncGroup-PasswordSyncGroup $Result
New-PasswordSyncGroup -PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# New-PasswordSyncGroup -PasswordSyncGroup $PasswordSyncGroup
@@ -138,7 +137,7 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync
# Delete Password Sync Group by ID
try {
Remove-PasswordSyncGroup-Id $Id
Remove-PasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Remove-PasswordSyncGroup -Id $Id
@@ -181,7 +180,7 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync
# Get Password Sync Group by ID
try {
Get-PasswordSyncGroup-Id $Id
Get-PasswordSyncGroup -Id $Id
# Below is a request that includes all optional parameters
# Get-PasswordSyncGroup -Id $Id
@@ -280,7 +279,7 @@ $PasswordSyncGroup = @"{
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
Update-PasswordSyncGroup-Id $Id -PasswordSyncGroup $Result
Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $PasswordSyncGroup

7
docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md
View File

@@ -1,4 +1,3 @@
---
id: personal-access-tokens
title: PersonalAccessTokens
@@ -71,7 +70,7 @@ $CreatePersonalAccessTokenRequest = @"{
try {
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
New-PersonalAccessToken-CreatePersonalAccessTokenRequest $Result
New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result
# Below is a request that includes all optional parameters
# New-PersonalAccessToken -CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest
@@ -114,7 +113,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id
# Delete Personal Access Token
try {
Remove-PersonalAccessToken-Id $Id
Remove-PersonalAccessToken -Id $Id
# Below is a request that includes all optional parameters
# Remove-PersonalAccessToken -Id $Id
@@ -210,7 +209,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-PersonalAccessToken-Id $Id -JsonPatchOperation $Result
Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-PersonalAccessToken -Id $Id -JsonPatchOperation $JsonPatchOperation

1
docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesApi.md
View File

@@ -1,4 +1,3 @@
---
id: public-identities
title: PublicIdentities

3
docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md
View File

@@ -1,4 +1,3 @@
---
id: public-identities-config
title: PublicIdentitiesConfig
@@ -118,7 +117,7 @@ $PublicIdentityConfig = @"{
try {
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig
Update-PublicIdentityConfig-PublicIdentityConfig $Result
Update-PublicIdentityConfig -PublicIdentityConfig $Result
# Below is a request that includes all optional parameters
# Update-PublicIdentityConfig -PublicIdentityConfig $PublicIdentityConfig

9
docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md
View File

@@ -1,4 +1,3 @@
---
id: reports-data-extraction
title: ReportsDataExtraction
@@ -58,7 +57,7 @@ $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to
# Cancel Report
try {
Suspend-Report-Id $Id
Suspend-Report -Id $Id
# Below is a request that includes all optional parameters
# Suspend-Report -Id $Id
@@ -107,7 +106,7 @@ $Auditable = $true # Boolean | Enables auditing for current report download. Wil
# Get Report File
try {
Get-Report-TaskResultId $TaskResultId -FileFormat $FileFormat
Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat
# Below is a request that includes all optional parameters
# Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable
@@ -151,7 +150,7 @@ $Completed = $true # Boolean | state of task result to apply ordering when resul
# Get Report Result
try {
Get-ReportResult-TaskResultId $TaskResultId
Get-ReportResult -TaskResultId $TaskResultId
# Below is a request that includes all optional parameters
# Get-ReportResult -TaskResultId $TaskResultId -Completed $Completed
@@ -200,7 +199,7 @@ $ReportDetails = @"{
try {
$Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails
Start-Report-ReportDetails $Result
Start-Report -ReportDetails $Result
# Below is a request that includes all optional parameters
# Start-Report -ReportDetails $ReportDetails

1
docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md
View File

@@ -1,4 +1,3 @@
---
id: requestable-objects
title: RequestableObjects

13
docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md
View File

@@ -1,4 +1,3 @@
---
id: roles
title: Roles
@@ -256,7 +255,7 @@ $Role = @"{
try {
$Result = ConvertFrom-JsonToRole -Json $Role
New-Role-Role $Result
New-Role -Role $Result
# Below is a request that includes all optional parameters
# New-Role -Role $Role
@@ -304,7 +303,7 @@ $RoleBulkDeleteRequest = @"{
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
Remove-BulkRoles-RoleBulkDeleteRequest $Result
Remove-BulkRoles -RoleBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-BulkRoles -RoleBulkDeleteRequest $RoleBulkDeleteRequest
@@ -348,7 +347,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Delete a Role
try {
Remove-Role-Id $Id
Remove-Role -Id $Id
# Below is a request that includes all optional parameters
# Remove-Role -Id $Id
@@ -391,7 +390,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Get a Role
try {
Get-Role-Id $Id
Get-Role -Id $Id
# Below is a request that includes all optional parameters
# Get-Role -Id $Id
@@ -443,7 +442,7 @@ $Sorters = "aliasName,name" # String | Sort results using the standard syntax de
# List Identities assigned a Role
try {
Get-RoleAssignedIdentities-Id $Id
Get-RoleAssignedIdentities -Id $Id
# Below is a request that includes all optional parameters
# Get-RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
@@ -568,7 +567,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Role-Id $Id -JsonPatchOperation $Result
Update-Role -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Role -Id $Id -JsonPatchOperation $JsonPatchOperation

29
docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md
View File

@@ -1,4 +1,3 @@
---
id: sod-policies
title: SODPolicies
@@ -151,7 +150,7 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
New-SodPolicy-SodPolicy $Result
New-SodPolicy -SodPolicy $Result
# Below is a request that includes all optional parameters
# New-SodPolicy -SodPolicy $SodPolicy
@@ -197,7 +196,7 @@ $Logical = $true # Boolean | Indicates whether this is a soft delete (logical tr
# Delete SOD policy by ID
try {
Remove-SodPolicy-Id $Id
Remove-SodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Remove-SodPolicy -Id $Id -Logical $Logical
@@ -240,7 +239,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy
# Delete SOD policy schedule
try {
Remove-SodPolicySchedule-Id $Id
Remove-SodPolicySchedule -Id $Id
# Below is a request that includes all optional parameters
# Remove-SodPolicySchedule -Id $Id
@@ -285,7 +284,7 @@ $FileName = "custom-name" # String | Custom Name for the file.
# Download custom violation report
try {
Get-CustomViolationReport-ReportResultId $ReportResultId -FileName $FileName
Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
# Below is a request that includes all optional parameters
# Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName
@@ -328,7 +327,7 @@ $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the re
# Download violation report
try {
Get-DefaultViolationReport-ReportResultId $ReportResultId
Get-DefaultViolationReport -ReportResultId $ReportResultId
# Below is a request that includes all optional parameters
# Get-DefaultViolationReport -ReportResultId $ReportResultId
@@ -412,7 +411,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy
# Get SOD policy by ID
try {
Get-SodPolicy-Id $Id
Get-SodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Get-SodPolicy -Id $Id
@@ -454,7 +453,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy
# Get SOD policy schedule
try {
Get-SodPolicySchedule-Id $Id
Get-SodPolicySchedule -Id $Id
# Below is a request that includes all optional parameters
# Get-SodPolicySchedule -Id $Id
@@ -497,7 +496,7 @@ $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of th
# Get violation report run status
try {
Get-SodViolationReportRunStatus-ReportResultId $ReportResultId
Get-SodViolationReportRunStatus -ReportResultId $ReportResultId
# Below is a request that includes all optional parameters
# Get-SodViolationReportRunStatus -ReportResultId $ReportResultId
@@ -540,7 +539,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation
# Get SOD violation report status
try {
Get-SodViolationReportStatus-Id $Id
Get-SodViolationReportStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-SodViolationReportStatus -Id $Id
@@ -644,7 +643,7 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-SodPolicy-Id $Id -JsonPatchOperation $Result
Update-SodPolicy -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation
@@ -726,7 +725,7 @@ $SodPolicySchedule = @"{
try {
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
Send-PolicySchedule-Id $Id -SodPolicySchedule $Result
Send-PolicySchedule -Id $Id -SodPolicySchedule $Result
# Below is a request that includes all optional parameters
# Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule
@@ -828,7 +827,7 @@ $SodPolicy = @"{
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
Send-SodPolicy-Id $Id -SodPolicy $Result
Send-SodPolicy -Id $Id -SodPolicy $Result
# Below is a request that includes all optional parameters
# Send-SodPolicy -Id $Id -SodPolicy $SodPolicy
@@ -870,7 +869,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run
# Evaluate one policy by ID
try {
Start-EvaluateSodPolicy-Id $Id
Start-EvaluateSodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Start-EvaluateSodPolicy -Id $Id
@@ -957,7 +956,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run
# Runs SOD policy violation report
try {
Start-SodPolicy-Id $Id
Start-SodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Start-SodPolicy -Id $Id

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

@@ -1,4 +1,3 @@
---
id: sod-violations
title: SODViolations
@@ -84,7 +83,7 @@ $IdentityWithNewAccess = @"{
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess
Start-PredictSodViolations-IdentityWithNewAccess $Result
Start-PredictSodViolations -IdentityWithNewAccess $Result
# Below is a request that includes all optional parameters
# Start-PredictSodViolations -IdentityWithNewAccess $IdentityWithNewAccess
@@ -128,7 +127,7 @@ $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, access
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1
Start-ViolationCheck-IdentityWithNewAccess1 $Result
Start-ViolationCheck -IdentityWithNewAccess1 $Result
# Below is a request that includes all optional parameters
# Start-ViolationCheck -IdentityWithNewAccess1 $IdentityWithNewAccess1

11
docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md
View File

@@ -1,4 +1,3 @@
---
id: saved-search
title: SavedSearch
@@ -69,7 +68,7 @@ $CreateSavedSearchRequest = @""@
try {
$Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest
New-SavedSearch-CreateSavedSearchRequest $Result
New-SavedSearch -CreateSavedSearchRequest $Result
# Below is a request that includes all optional parameters
# New-SavedSearch -CreateSavedSearchRequest $CreateSavedSearchRequest
@@ -113,7 +112,7 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Delete document by ID
try {
Remove-SavedSearch-Id $Id
Remove-SavedSearch -Id $Id
# Below is a request that includes all optional parameters
# Remove-SavedSearch -Id $Id
@@ -170,7 +169,7 @@ $SearchArguments = @"{
try {
$Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments
Invoke-ExecuteSavedSearch-Id $Id -SearchArguments $Result
Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result
# Below is a request that includes all optional parameters
# Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $SearchArguments
@@ -214,7 +213,7 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Return saved search by ID
try {
Get-SavedSearch-Id $Id
Get-SavedSearch -Id $Id
# Below is a request that includes all optional parameters
# Get-SavedSearch -Id $Id
@@ -355,7 +354,7 @@ $SavedSearch = @"{
try {
$Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch
Send-SavedSearch-Id $Id -SavedSearch $Result
Send-SavedSearch -Id $Id -SavedSearch $Result
# Below is a request that includes all optional parameters
# Send-SavedSearch -Id $Id -SavedSearch $SavedSearch

11
docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md
View File

@@ -1,4 +1,3 @@
---
id: scheduled-search
title: ScheduledSearch
@@ -86,7 +85,7 @@ $CreateScheduledSearchRequest = @"{savedSearchId=9c620e13-cd33-4804-a13d-403bd7b
try {
$Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest
New-ScheduledSearch-CreateScheduledSearchRequest $Result
New-ScheduledSearch -CreateScheduledSearchRequest $Result
# Below is a request that includes all optional parameters
# New-ScheduledSearch -CreateScheduledSearchRequest $CreateScheduledSearchRequest
@@ -130,7 +129,7 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Delete a Scheduled Search
try {
Remove-ScheduledSearch-Id $Id
Remove-ScheduledSearch -Id $Id
# Below is a request that includes all optional parameters
# Remove-ScheduledSearch -Id $Id
@@ -173,7 +172,7 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Get a Scheduled Search
try {
Get-ScheduledSearch-Id $Id
Get-ScheduledSearch -Id $Id
# Below is a request that includes all optional parameters
# Get-ScheduledSearch -Id $Id
@@ -270,7 +269,7 @@ $TypedReference = @"{
try {
$Result = ConvertFrom-JsonToTypedReference -Json $TypedReference
Invoke-UnsubscribeScheduledSearch-Id $Id -TypedReference $Result
Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result
# Below is a request that includes all optional parameters
# Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $TypedReference
@@ -359,7 +358,7 @@ $ScheduledSearch = @"{
try {
$Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch
Update-ScheduledSearch-Id $Id -ScheduledSearch $Result
Update-ScheduledSearch -Id $Id -ScheduledSearch $Result
# Below is a request that includes all optional parameters
# Update-ScheduledSearch -Id $Id -ScheduledSearch $ScheduledSearch

9
docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md
View File

@@ -1,4 +1,3 @@
---
id: search
title: Search
@@ -201,7 +200,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-Aggregate-Search $Result
Search-Aggregate -Search $Result
# Below is a request that includes all optional parameters
# Search-Aggregate -Search $Search -Offset $Offset -Limit $Limit -Count $Count
@@ -360,7 +359,7 @@ $Search = @"{
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-Count-Search $Result
Search-Count -Search $Result
# Below is a request that includes all optional parameters
# Search-Count -Search $Search
@@ -405,7 +404,7 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document
# Get a Document by ID
try {
Search-Get-Index $Index -Id $Id
Search-Get -Index $Index -Id $Id
# Below is a request that includes all optional parameters
# Search-Get -Index $Index -Id $Id
@@ -570,7 +569,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
try {
$Result = ConvertFrom-JsonToSearch -Json $Search
Search-Post-Search $Result
Search-Post -Search $Result
# Below is a request that includes all optional parameters
# Search-Post -Search $Search -Offset $Offset -Limit $Limit -Count $Count

9
docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md
View File

@@ -1,4 +1,3 @@
---
id: search-attribute-configuration
title: SearchAttributeConfiguration
@@ -83,7 +82,7 @@ $SearchAttributeConfig = @"{
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-SearchAttributeConfig-SearchAttributeConfig $Result
New-SearchAttributeConfig -SearchAttributeConfig $Result
# Below is a request that includes all optional parameters
# New-SearchAttributeConfig -SearchAttributeConfig $SearchAttributeConfig
@@ -126,7 +125,7 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf
# Delete Extended Search Attribute
try {
Remove-SearchAttributeConfig-Name $Name
Remove-SearchAttributeConfig -Name $Name
# Below is a request that includes all optional parameters
# Remove-SearchAttributeConfig -Name $Name
@@ -210,7 +209,7 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf
# Get Extended Search Attribute
try {
Get-SingleSearchAttributeConfig-Name $Name
Get-SingleSearchAttributeConfig -Name $Name
# Below is a request that includes all optional parameters
# Get-SingleSearchAttributeConfig -Name $Name
@@ -263,7 +262,7 @@ $Name = "promotedMailAttribute" # String | Name of the search attribute configur
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-SearchAttributeConfig-Name $Name -JsonPatchOperation $Result
Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $JsonPatchOperation

9
docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md
View File

@@ -1,4 +1,3 @@
---
id: segments
title: Segments
@@ -98,7 +97,7 @@ $Segment = @"{
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
New-Segment-Segment $Result
New-Segment -Segment $Result
# Below is a request that includes all optional parameters
# New-Segment -Segment $Segment
@@ -142,7 +141,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete.
# Delete Segment by ID
try {
Remove-Segment-Id $Id
Remove-Segment -Id $Id
# Below is a request that includes all optional parameters
# Remove-Segment -Id $Id
@@ -185,7 +184,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve.
# Get Segment by ID
try {
Get-Segment-Id $Id
Get-Segment -Id $Id
# Below is a request that includes all optional parameters
# Get-Segment -Id $Id
@@ -280,7 +279,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-Segment-Id $Id -RequestBody $Result
Update-Segment -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-Segment -Id $Id -RequestBody $RequestBody

15
docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md
View File

@@ -1,4 +1,3 @@
---
id: service-desk-integration
title: ServiceDeskIntegration
@@ -120,7 +119,7 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
New-ServiceDeskIntegration-ServiceDeskIntegrationDto $Result
New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# New-ServiceDeskIntegration -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto
@@ -163,7 +162,7 @@ $Id = "anId" # String | ID of Service Desk integration to delete
# Delete a Service Desk integration
try {
Remove-ServiceDeskIntegration-Id $Id
Remove-ServiceDeskIntegration -Id $Id
# Below is a request that includes all optional parameters
# Remove-ServiceDeskIntegration -Id $Id
@@ -206,7 +205,7 @@ $Id = "anId" # String | ID of the Service Desk integration to get
# Get a Service Desk integration
try {
Get-ServiceDeskIntegration-Id $Id
Get-ServiceDeskIntegration -Id $Id
# Below is a request that includes all optional parameters
# Get-ServiceDeskIntegration -Id $Id
@@ -249,7 +248,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk
# Service Desk integration template by scriptName
try {
Get-ServiceDeskIntegrationTemplate-ScriptName $ScriptName
Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName
@@ -428,7 +427,7 @@ $PatchServiceDeskIntegrationRequest = @""@
try {
$Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest
Update-ServiceDeskIntegration-Id $Id -PatchServiceDeskIntegrationRequest $Result
Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result
# Below is a request that includes all optional parameters
# Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest
@@ -507,7 +506,7 @@ $ServiceDeskIntegrationDto = @"{
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
Send-ServiceDeskIntegration-Id $Id -ServiceDeskIntegrationDto $Result
Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto
@@ -554,7 +553,7 @@ $QueuedCheckConfigDetails = @"{
try {
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
Update-StatusCheckDetails-QueuedCheckConfigDetails $Result
Update-StatusCheckDetails -QueuedCheckConfigDetails $Result
# Below is a request that includes all optional parameters
# Update-StatusCheckDetails -QueuedCheckConfigDetails $QueuedCheckConfigDetails

5
docs/tools/sdk/powershell/Reference/V3/Methods/SourceUsagesApi.md
View File

@@ -1,4 +1,3 @@
---
id: source-usages
title: SourceUsages
@@ -56,7 +55,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source
# Finds status of source usage
try {
Get-StatusBySourceId-SourceId $SourceId
Get-StatusBySourceId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-StatusBySourceId -SourceId $SourceId
@@ -106,7 +105,7 @@ $Sorters = "-date" # String | Sort results using the standard syntax described i
# Returns source usage insights
try {
Get-UsagesBySourceId-SourceId $SourceId
Get-UsagesBySourceId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters

51
docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md
View File

@@ -1,4 +1,3 @@
---
id: sources
title: Sources
@@ -179,7 +178,7 @@ $ProvisioningPolicyDto = @"{
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
New-ProvisioningPolicy-SourceId $SourceId -ProvisioningPolicyDto $Result
New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto
@@ -306,7 +305,7 @@ $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures
try {
$Result = ConvertFrom-JsonToSource -Json $Source
New-Source-Source $Result
New-Source -Source $Result
# Below is a request that includes all optional parameters
# New-Source -Source $Source -ProvisionAsCsv $ProvisionAsCsv
@@ -385,7 +384,7 @@ $Schema = @"{
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
New-SourceSchema-SourceId $SourceId -Schema $Result
New-SourceSchema -SourceId $SourceId -Schema $Result
# Below is a request that includes all optional parameters
# New-SourceSchema -SourceId $SourceId -Schema $Schema
@@ -430,7 +429,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I
# Delete Provisioning Policy by UsageType
try {
Remove-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType
Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
# Below is a request that includes all optional parameters
# Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
@@ -474,7 +473,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Delete Source by ID
try {
Remove-Source-Id $Id
Remove-Source -Id $Id
# Below is a request that includes all optional parameters
# Remove-Source -Id $Id
@@ -519,7 +518,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Delete Source Schema by ID
try {
Remove-SourceSchema-SourceId $SourceId -SchemaId $SchemaId
Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
# Below is a request that includes all optional parameters
# Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
@@ -563,7 +562,7 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
# Downloads source accounts schema template
try {
Get-AccountsSchema-Id $Id
Get-AccountsSchema -Id $Id
# Below is a request that includes all optional parameters
# Get-AccountsSchema -Id $Id
@@ -610,7 +609,7 @@ $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optiona
# Downloads source entitlements schema template
try {
Get-EntitlementsSchema-Id $Id
Get-EntitlementsSchema -Id $Id
# Below is a request that includes all optional parameters
# Get-EntitlementsSchema -Id $Id -SchemaName $SchemaName
@@ -655,7 +654,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I
# Get Provisioning Policy by UsageType
try {
Get-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType
Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
# Below is a request that includes all optional parameters
# Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
@@ -698,7 +697,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Get Source by ID
try {
Get-Source-Id $Id
Get-Source -Id $Id
# Below is a request that includes all optional parameters
# Get-Source -Id $Id
@@ -741,7 +740,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Get Source Connections by ID
try {
Get-SourceConnections-Id $Id
Get-SourceConnections -Id $Id
# Below is a request that includes all optional parameters
# Get-SourceConnections -Id $Id
@@ -784,7 +783,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
# Fetches source health by id
try {
Get-SourceHealth-SourceId $SourceId
Get-SourceHealth -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-SourceHealth -SourceId $SourceId
@@ -830,7 +829,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Get Source Schema by ID
try {
Get-SourceSchema-SourceId $SourceId -SchemaId $SchemaId
Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
# Below is a request that includes all optional parameters
# Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId
@@ -877,7 +876,7 @@ $IncludeNames = "account" # String | A comma-separated list of schema names to f
# List Schemas on Source
try {
Get-SourceSchemas-SourceId $SourceId
Get-SourceSchemas -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames
@@ -927,7 +926,7 @@ $File = # System.IO.FileInfo | (optional)
# Uploads source accounts schema template
try {
Import-AccountsSchema-Id $Id
Import-AccountsSchema -Id $Id
# Below is a request that includes all optional parameters
# Import-AccountsSchema -Id $Id -File $File
@@ -971,7 +970,7 @@ $File = # System.IO.FileInfo | (optional)
# Upload connector file to source
try {
Import-ConnectorFile-SourceId $SourceId
Import-ConnectorFile -SourceId $SourceId
# Below is a request that includes all optional parameters
# Import-ConnectorFile -SourceId $SourceId -File $File
@@ -1023,7 +1022,7 @@ $File = # System.IO.FileInfo | (optional)
# Uploads source entitlements schema template
try {
Import-EntitlementsSchema-Id $Id
Import-EntitlementsSchema -Id $Id
# Below is a request that includes all optional parameters
# Import-EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File
@@ -1066,7 +1065,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id
# Lists ProvisioningPolicies
try {
Get-ProvisioningPolicies-SourceId $SourceId
Get-ProvisioningPolicies -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-ProvisioningPolicies -SourceId $SourceId
@@ -1210,7 +1209,7 @@ $ProvisioningPolicyDto = @"{
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
Send-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $ProvisioningPolicyDto
@@ -1350,7 +1349,7 @@ $Source = @"{
try {
$Result = ConvertFrom-JsonToSource -Json $Source
Send-Source-Id $Id -Source $Result
Send-Source -Id $Id -Source $Result
# Below is a request that includes all optional parameters
# Send-Source -Id $Id -Source $Source
@@ -1441,7 +1440,7 @@ $Schema = @"{
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
Send-SourceSchema-SourceId $SourceId -SchemaId $SchemaId -Schema $Result
Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result
# Below is a request that includes all optional parameters
# Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Schema
@@ -1527,7 +1526,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
Update-ProvisioningPoliciesInBulk-SourceId $SourceId -ProvisioningPolicyDto $Result
Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto
@@ -1582,7 +1581,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $JsonPatchOperation
@@ -1648,7 +1647,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Source-Id $Id -JsonPatchOperation $Result
Update-Source -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Source -Id $Id -JsonPatchOperation $JsonPatchOperation
@@ -1730,7 +1729,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-SourceSchema-SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $JsonPatchOperation

15
docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md
View File

@@ -1,4 +1,3 @@
---
id: tagged-objects
title: TaggedObjects
@@ -114,7 +113,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to dele
# Delete Object Tags
try {
Remove-TaggedObject-Type $Type -Id $Id
Remove-TaggedObject -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Remove-TaggedObject -Type $Type -Id $Id
@@ -168,7 +167,7 @@ $BulkRemoveTaggedObject = @"{
try {
$Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject
Remove-TagsToManyObject-BulkRemoveTaggedObject $Result
Remove-TagsToManyObject -BulkRemoveTaggedObject $Result
# Below is a request that includes all optional parameters
# Remove-TagsToManyObject -BulkRemoveTaggedObject $BulkRemoveTaggedObject
@@ -212,7 +211,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen
# Get Tagged Object
try {
Get-TaggedObject-Type $Type -Id $Id
Get-TaggedObject -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Get-TaggedObject -Type $Type -Id $Id
@@ -314,7 +313,7 @@ $Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filte
# List Tagged Objects by Type
try {
Get-TaggedObjectsByType-Type $Type
Get-TaggedObjectsByType -Type $Type
# Below is a request that includes all optional parameters
# Get-TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
@@ -368,7 +367,7 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Send-TaggedObject-Type $Type -Id $Id -TaggedObject $Result
Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result
# Below is a request that includes all optional parameters
# Send-TaggedObject -Type $Type -Id $Id -TaggedObject $TaggedObject
@@ -420,7 +419,7 @@ $TaggedObject = @"{
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
Set-TagToObject-TaggedObject $Result
Set-TagToObject -TaggedObject $Result
# Below is a request that includes all optional parameters
# Set-TagToObject -TaggedObject $TaggedObject
@@ -475,7 +474,7 @@ $BulkAddTaggedObject = @"{
try {
$Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject
Set-TagsToManyObjects-BulkAddTaggedObject $Result
Set-TagsToManyObjects -BulkAddTaggedObject $Result
# Below is a request that includes all optional parameters
# Set-TagsToManyObjects -BulkAddTaggedObject $BulkAddTaggedObject

9
docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md
View File

@@ -1,4 +1,3 @@
---
id: transforms
title: Transforms
@@ -84,7 +83,7 @@ $Transform = @"{
try {
$Result = ConvertFrom-JsonToTransform -Json $Transform
New-Transform-Transform $Result
New-Transform -Transform $Result
# Below is a request that includes all optional parameters
# New-Transform -Transform $Transform
@@ -127,7 +126,7 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete
# Delete a transform
try {
Remove-Transform-Id $Id
Remove-Transform -Id $Id
# Below is a request that includes all optional parameters
# Remove-Transform -Id $Id
@@ -170,7 +169,7 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retriev
# Transform by ID
try {
Get-Transform-Id $Id
Get-Transform -Id $Id
# Below is a request that includes all optional parameters
# Get-Transform -Id $Id
@@ -286,7 +285,7 @@ $Transform = @"{
# Update a transform
try {
Update-Transform-Id $Id
Update-Transform -Id $Id
# Below is a request that includes all optional parameters
# Update-Transform -Id $Id -Transform $Transform

5
docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md
View File

@@ -1,4 +1,3 @@
---
id: vendor-connector-mappings
title: VendorConnectorMappings
@@ -79,7 +78,7 @@ $VendorConnectorMapping = @"{
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
New-VendorConnectorMapping-VendorConnectorMapping $Result
New-VendorConnectorMapping -VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# New-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping
@@ -146,7 +145,7 @@ $VendorConnectorMapping = @"{
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
Remove-VendorConnectorMapping-VendorConnectorMapping $Result
Remove-VendorConnectorMapping -VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# Remove-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping

17
docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md
View File

@@ -1,4 +1,3 @@
---
id: work-items
title: WorkItems
@@ -81,7 +80,7 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap
# Approve an Approval Item
try {
Approve-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId
Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
@@ -124,7 +123,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve Approval Items
try {
Approve-ApprovalItemsInBulk-Id $Id
Approve-ApprovalItemsInBulk -Id $Id
# Below is a request that includes all optional parameters
# Approve-ApprovalItemsInBulk -Id $Id
@@ -167,7 +166,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Complete a Work Item
try {
Complete-WorkItem-Id $Id
Complete-WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-WorkItem -Id $Id
@@ -341,7 +340,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
# Get a Work Item
try {
Get-WorkItem-Id $Id
Get-WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Get-WorkItem -Id $Id
@@ -476,7 +475,7 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap
# Reject an Approval Item
try {
Deny-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId
Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
@@ -519,7 +518,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject Approval Items
try {
Deny-ApprovalItemsInBulk-Id $Id
Deny-ApprovalItemsInBulk -Id $Id
# Below is a request that includes all optional parameters
# Deny-ApprovalItemsInBulk -Id $Id
@@ -568,7 +567,7 @@ $WorkItemForward = @"{
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Send-WorkItemForward-Id $Id -WorkItemForward $Result
Send-WorkItemForward -Id $Id -WorkItemForward $Result
# Below is a request that includes all optional parameters
# Send-WorkItemForward -Id $Id -WorkItemForward $WorkItemForward
@@ -614,7 +613,7 @@ $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Sele
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Submit-AccountSelection-Id $Id -RequestBody $Result
Submit-AccountSelection -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Submit-AccountSelection -Id $Id -RequestBody $RequestBody

27
docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md
View File

@@ -1,4 +1,3 @@
---
id: workflows
title: Workflows
@@ -71,7 +70,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution I
# Cancel Workflow Execution by ID
try {
Suspend-WorkflowExecution-Id $Id
Suspend-WorkflowExecution -Id $Id
# Below is a request that includes all optional parameters
# Suspend-WorkflowExecution -Id $Id
@@ -115,7 +114,7 @@ $CreateExternalExecuteWorkflowRequest = @""@
# Execute Workflow via External Trigger
try {
New-ExternalExecuteWorkflow-Id $Id
New-ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest
@@ -158,7 +157,7 @@ $CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568
try {
$Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest
New-Workflow-CreateWorkflowRequest $Result
New-Workflow -CreateWorkflowRequest $Result
# Below is a request that includes all optional parameters
# New-Workflow -CreateWorkflowRequest $CreateWorkflowRequest
@@ -200,7 +199,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Generate External Trigger OAuth Client
try {
New-WorkflowExternalTrigger-Id $Id
New-WorkflowExternalTrigger -Id $Id
# Below is a request that includes all optional parameters
# New-WorkflowExternalTrigger -Id $Id
@@ -242,7 +241,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
# Delete Workflow By Id
try {
Remove-Workflow-Id $Id
Remove-Workflow -Id $Id
# Below is a request that includes all optional parameters
# Remove-Workflow -Id $Id
@@ -284,7 +283,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Get Workflow By Id
try {
Get-Workflow-Id $Id
Get-Workflow -Id $Id
# Below is a request that includes all optional parameters
# Get-Workflow -Id $Id
@@ -327,7 +326,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID.
# Get Workflow Execution
try {
Get-WorkflowExecution-Id $Id
Get-WorkflowExecution -Id $Id
# Below is a request that includes all optional parameters
# Get-WorkflowExecution -Id $Id
@@ -370,7 +369,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execu
# Get Workflow Execution History
try {
Get-WorkflowExecutionHistory-Id $Id
Get-WorkflowExecutionHistory -Id $Id
# Below is a request that includes all optional parameters
# Get-WorkflowExecutionHistory -Id $Id
@@ -431,7 +430,7 @@ $Filters = 'status eq "Failed"' # String | Filter results using the standard syn
# List Workflow Executions
try {
Get-WorkflowExecutions-Id $Id
Get-WorkflowExecutions -Id $Id
# Below is a request that includes all optional parameters
# Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
@@ -697,7 +696,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-Workflow-Id $Id -JsonPatchOperation $Result
Update-Workflow -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-Workflow -Id $Id -JsonPatchOperation $JsonPatchOperation
@@ -780,7 +779,7 @@ $WorkflowBody = @"{
try {
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
Send-Workflow-Id $Id -WorkflowBody $Result
Send-Workflow -Id $Id -WorkflowBody $Result
# Below is a request that includes all optional parameters
# Send-Workflow -Id $Id -WorkflowBody $WorkflowBody
@@ -824,7 +823,7 @@ $TestExternalExecuteWorkflowRequest = @""@
# Test Workflow via External Trigger
try {
Test-ExternalExecuteWorkflow-Id $Id
Test-ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest
@@ -871,7 +870,7 @@ $TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b,
try {
$Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest
Test-Workflow-Id $Id -TestWorkflowRequest $Result
Test-Workflow -Id $Id -TestWorkflowRequest $Result
# Below is a request that includes all optional parameters
# Test-Workflow -Id $Id -TestWorkflowRequest $TestWorkflowRequest

10
docs/tools/sdk/powershell/Reference/V3/Models/Access.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'Access', 'Access']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | Pointer to **String** | | [optional]
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Description** | Pointer to **String** | | [optional]
**Id** | **String** | The unique ID of the referenced object. | [optional]
**Name** | **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | **String** | | [optional]
**Type** | [**DtoType**](dto-type) | | [optional]
**Description** | **String** | | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessConstraint.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'AccessConstraint'
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Type of Access | [required]
**Ids** | Pointer to **[]String** | Must be set only if operator is SELECTED. | [optional]
**Operator** | **Enum** [ "ALL", "SELECTED" ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required]
**Type** | **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Type of Access | [required]
**Ids** | **[]String** | Must be set only if operator is SELECTED. | [optional]
**Operator** | **Enum** [ "ALL", "SELECTED" ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'AccessCriteria']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | Pointer to **String** | Business name for the access construct list | [optional]
**CriteriaList** | Pointer to [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional]
**Name** | **String** | Business name for the access construct list | [optional]
**CriteriaList** | [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessCriteriaCriteriaListInner.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'Ac
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Type of the propery to which this reference applies to | [optional]
**Id** | Pointer to **String** | ID of the object to which this reference applies to | [optional]
**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies to | [optional]
**Type** | **Enum** [ "ENTITLEMENT" ] | Type of the propery to which this reference applies to | [optional]
**Id** | **String** | ID of the object to which this reference applies to | [optional]
**Name** | **String** | Human-readable display name of the object to which this reference applies to | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessItemRequestedFor.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'AccessItemR
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity the access item is requested for. | [optional]
**Id** | Pointer to **String** | ID of identity the access item is requested for. | [optional]
**Name** | Pointer to **String** | Human-readable display name of identity the access item is requested for. | [optional]
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity the access item is requested for. | [optional]
**Id** | **String** | ID of identity the access item is requested for. | [optional]
**Name** | **String** | Human-readable display name of identity the access item is requested for. | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessItemRequester.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'AccessItemRequ
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item requester's DTO type. | [optional]
**Id** | Pointer to **String** | Access item requester's identity ID. | [optional]
**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional]
**Type** | **Enum** [ "IDENTITY" ] | Access item requester's DTO type. | [optional]
**Id** | **String** | Access item requester's identity ID. | [optional]
**Name** | **String** | Access item owner's human-readable display name. | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessItemReviewedBy.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'AccessItemRev
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who reviewed the access item request. | [optional]
**Id** | Pointer to **String** | ID of identity who reviewed the access item request. | [optional]
**Name** | Pointer to **String** | Human-readable display name of identity who reviewed the access item request. | [optional]
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who reviewed the access item request. | [optional]
**Id** | **String** | ID of identity who reviewed the access item request. | [optional]
**Name** | **String** | Human-readable display name of identity who reviewed the access item request. | [optional]
## Examples

28
docs/tools/sdk/powershell/Reference/V3/Models/AccessProfile.md
View File

@@ -16,20 +16,20 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The ID of the Access Profile | [optional] [readonly]
**Name** | **String** | Name of the Access Profile | [required]
**Description** | Pointer to **String** | Information about the Access Profile | [optional]
**Created** | Pointer to **System.DateTime** | Date the Access Profile was created | [optional] [readonly]
**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly]
**Enabled** | Pointer to **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true]
**Owner** | [**OwnerReference**](owner-reference) | | [required]
**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required]
**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional]
**Requestable** | Pointer to **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true]
**AccessRequestConfig** | Pointer to [**Requestability**](requestability) | | [optional]
**RevocationRequestConfig** | Pointer to [**Revocability**](revocability) | | [optional]
**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
**ProvisioningCriteria** | Pointer to [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional]
**Id** | **String** | The ID of the Access Profile | [optional] [readonly]
**Name** | **String** | Name of the Access Profile | [required]
**Description** | **String** | Information about the Access Profile | [optional]
**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly]
**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly]
**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true]
**Owner** | [**OwnerReference**](owner-reference) | | [required]
**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required]
**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional]
**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true]
**AccessRequestConfig** | [**Requestability**](requestability) | | [optional]
**RevocationRequestConfig** | [**Revocability**](revocability) | | [optional]
**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
**ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'Access
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApproverType** | Pointer to **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional]
**ApproverId** | Pointer to **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional]
**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional]
**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'Acc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessProfileIds** | Pointer to **[]String** | List of IDs of Access Profiles to be deleted. | [optional]
**BestEffortOnly** | Pointer to **Boolean** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional]
**AccessProfileIds** | **[]String** | List of IDs of Access Profiles to be deleted. | [optional]
**BestEffortOnly** | **Boolean** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileBulkDeleteResponse.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'Ac
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TaskId** | Pointer to **String** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional]
**Pending** | Pointer to **[]String** | List of IDs of Access Profiles which are pending deletion. | [optional]
**InUse** | Pointer to [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional]
**TaskId** | **String** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional]
**Pending** | **[]String** | List of IDs of Access Profiles which are pending deletion. | [optional]
**InUse** | [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional]
## Examples

30
docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileDocument.md
View File

@@ -16,21 +16,21 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'AccessProfil
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Access profile's ID. | [required]
**Name** | **String** | Access profile's name. | [required]
**Description** | Pointer to **String** | Access item's description. | [optional]
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Synced** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**Enabled** | Pointer to **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
**Requestable** | Pointer to **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
**RequestCommentsRequired** | Pointer to **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
**Owner** | Pointer to [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**Type** | **Enum** [ "accessprofile", "accountactivity", "account", "aggregation", "entitlement", "event", "identity", "role" ] | Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice. | [required]
**Source** | Pointer to [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional]
**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional]
**EntitlementCount** | Pointer to **Int32** | Number of entitlements. | [optional]
**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional]
**Id** | **String** | Access profile's ID. | [required]
**Name** | **String** | Access profile's name. | [required]
**Description** | **String** | Access item's description. | [optional]
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Synced** | **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**Enabled** | **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
**Requestable** | **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
**RequestCommentsRequired** | **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
**Owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**Type** | **Enum** [ "accessprofile", "accountactivity", "account", "aggregation", "entitlement", "event", "identity", "role" ] | Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice. | [required]
**Source** | [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional]
**Entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional]
**EntitlementCount** | **Int32** | Number of entitlements. | [optional]
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'A
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Source's ID. | [optional]
**Name** | Pointer to **String** | Source's name. | [optional]
**Id** | **String** | Source's ID. | [optional]
**Name** | **String** | Source's name. | [optional]
## Examples

20
docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileEntitlement.md
View File

@@ -16,16 +16,16 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'AccessPro
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | Pointer to **String** | | [optional]
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Description** | Pointer to **String** | | [optional]
**Source** | Pointer to [**Reference1**](reference1) | | [optional]
**Privileged** | Pointer to **Boolean** | | [optional]
**Attribute** | Pointer to **String** | | [optional]
**Value** | Pointer to **String** | | [optional]
**Standalone** | Pointer to **Boolean** | | [optional]
**Id** | **String** | The unique ID of the referenced object. | [optional]
**Name** | **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | **String** | | [optional]
**Type** | [**DtoType**](dto-type) | | [optional]
**Description** | **String** | | [optional]
**Source** | [**Reference1**](reference1) | | [optional]
**Privileged** | **Boolean** | | [optional]
**Attribute** | **String** | | [optional]
**Value** | **String** | | [optional]
**Standalone** | **Boolean** | | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileRef.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'AccessProfileRef'
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | ID of the Access Profile | [optional]
**Type** | Pointer to **Enum** [ "ACCESS_PROFILE" ] | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional]
**Name** | Pointer to **String** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional]
**Id** | **String** | ID of the Access Profile | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE" ] | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional]
**Name** | **String** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional]
## Examples

16
docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileRole.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'AccessProfileRol
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | Pointer to **String** | | [optional]
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Description** | Pointer to **String** | | [optional]
**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional]
**Disabled** | Pointer to **Boolean** | | [optional]
**Revocable** | Pointer to **Boolean** | | [optional]
**Id** | **String** | The unique ID of the referenced object. | [optional]
**Name** | **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | **String** | | [optional]
**Type** | [**DtoType**](dto-type) | | [optional]
**Description** | **String** | | [optional]
**Owner** | [**DisplayReference**](display-reference) | | [optional]
**Disabled** | **Boolean** | | [optional]
**Revocable** | **Boolean** | | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSourceRef.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfi
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The ID of the Source with with which the Access Profile is associated | [optional]
**Type** | Pointer to **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional]
**Name** | Pointer to **String** | The display name of the associated Source | [optional]
**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional]
**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional]
**Name** | **String** | The display name of the associated Source | [optional]
## Examples

16
docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSummary.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'AccessProfile
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | Pointer to **String** | | [optional]
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Description** | Pointer to **String** | | [optional]
**Source** | Pointer to [**Reference1**](reference1) | | [optional]
**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional]
**Revocable** | Pointer to **Boolean** | | [optional]
**Id** | **String** | The unique ID of the referenced object. | [optional]
**Name** | **String** | The human readable name of the referenced object. | [optional]
**DisplayName** | **String** | | [optional]
**Type** | [**DtoType**](dto-type) | | [optional]
**Description** | **String** | | [optional]
**Source** | [**Reference1**](reference1) | | [optional]
**Owner** | [**DisplayReference**](display-reference) | | [optional]
**Revocable** | **Boolean** | | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'AccessProfileUs
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessProfileId** | Pointer to **String** | ID of the Access Profile that is in use | [optional]
**UsedBy** | Pointer to [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional]
**AccessProfileId** | **String** | ID of the Access Profile that is in use | [optional]
**UsedBy** | [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileUsageUsedByInner.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'Acce
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to **Enum** [ "ROLE" ] | DTO type of role using the access profile. | [optional]
**Id** | Pointer to **String** | ID of role using the access profile. | [optional]
**Name** | Pointer to **String** | Display name of role using the access profile. | [optional]
**Type** | **Enum** [ "ROLE" ] | DTO type of role using the access profile. | [optional]
**Id** | **String** | ID of role using the access profile. | [optional]
**Name** | **String** | Display name of role using the access profile. | [optional]
## Examples

8
docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'AccessRequest']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required]
**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional]
**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required]
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional]
**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required]
**RequestType** | [**AccessRequestType**](access-request-type) | | [optional]
**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required]
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional]
## Examples

12
docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestConfig.md
View File

@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'AccessRequestC
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApprovalsMustBeExternal** | Pointer to **Boolean** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to $false]
**AutoApprovalEnabled** | Pointer to **Boolean** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to $false]
**ReauthorizationEnabled** | Pointer to **Boolean** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to $false]
**RequestOnBehalfOfConfig** | Pointer to [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional]
**ApprovalReminderAndEscalationConfig** | Pointer to [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional]
**EntitlementRequestConfig** | Pointer to [**EntitlementRequestConfig**](entitlement-request-config) | | [optional]
**ApprovalsMustBeExternal** | **Boolean** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to $false]
**AutoApprovalEnabled** | **Boolean** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to $false]
**ReauthorizationEnabled** | **Boolean** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to $false]
**RequestOnBehalfOfConfig** | [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional]
**ApprovalReminderAndEscalationConfig** | [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional]
**EntitlementRequestConfig** | [**EntitlementRequestConfig**](entitlement-request-config) | | [optional]
## Examples

10
docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'AccessRequestIte
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required]
**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required]
**Comment** | Pointer to **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional]
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional]
**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required]
**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required]
**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional]
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional]
**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional]
## Examples

12
docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestPhases.md
View File

@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'AccessRequestP
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Started** | Pointer to **System.DateTime** | The time that this phase started. | [optional]
**Finished** | Pointer to **System.DateTime** | The time that this phase finished. | [optional]
**Name** | Pointer to **String** | The name of this phase. | [optional]
**State** | Pointer to **Enum** [ "PENDING", "EXECUTING", "COMPLETED", "CANCELLED", "NOT_EXECUTED" ] | The state of this phase. | [optional]
**Result** | Pointer to **Enum** [ "SUCCESSFUL", "FAILED" ] | The state of this phase. | [optional]
**PhaseReference** | Pointer to **String** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional]
**Started** | **System.DateTime** | The time that this phase started. | [optional]
**Finished** | **System.DateTime** | The time that this phase finished. | [optional]
**Name** | **String** | The name of this phase. | [optional]
**State** | **Enum** [ "PENDING", "EXECUTING", "COMPLETED", "CANCELLED", "NOT_EXECUTED" ] | The state of this phase. | [optional]
**Result** | **Enum** [ "SUCCESSFUL", "FAILED" ] | The state of this phase. | [optional]
**PhaseReference** | **String** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'AccessReques
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**NewRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional]
**ExistingRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional]
**NewRequests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional]
**ExistingRequests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional]
## Examples

8
docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestTracking.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'AccessReques
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RequestedFor** | Pointer to **String** | The identity id in which the access request is for. | [optional]
**RequestedItemsDetails** | Pointer to [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional]
**AttributesHash** | Pointer to **String** | a hash representation of the access requested, useful for longer term tracking client side. | [optional]
**AccessRequestIds** | Pointer to **[]String** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional]
**RequestedFor** | **String** | The identity id in which the access request is for. | [optional]
**RequestedItemsDetails** | [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional]
**AttributesHash** | **String** | a hash representation of the access requested, useful for longer term tracking client side. | [optional]
**AccessRequestIds** | **[]String** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional]
## Examples

14
docs/tools/sdk/powershell/Reference/V3/Models/AccessReviewItem.md
View File

@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'AccessReviewItem'
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessSummary** | Pointer to [**AccessSummary**](access-summary) | | [optional]
**IdentitySummary** | Pointer to [**CertificationIdentitySummary**](certification-identity-summary) | | [optional]
**Id** | Pointer to **String** | The review item's id | [optional]
**Completed** | Pointer to **Boolean** | Whether the review item is complete | [optional]
**NewAccess** | Pointer to **Boolean** | Indicates whether the review item is for new access to a source | [optional]
**Decision** | Pointer to [**CertificationDecision**](certification-decision) | | [optional]
**Comments** | Pointer to **String** | Comments for this review item | [optional]
**AccessSummary** | [**AccessSummary**](access-summary) | | [optional]
**IdentitySummary** | [**CertificationIdentitySummary**](certification-identity-summary) | | [optional]
**Id** | **String** | The review item's id | [optional]
**Completed** | **Boolean** | Whether the review item is complete | [optional]
**NewAccess** | **Boolean** | Indicates whether the review item is for new access to a source | [optional]
**Decision** | [**CertificationDecision**](certification-decision) | | [optional]
**Comments** | **String** | Comments for this review item | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessReviewReassignment.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'AccessRev
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Reassign** | [**[]ReassignReference**](reassign-reference) | | [required]
**ReassignTo** | **String** | The ID of the identity to which the certification is reassigned | [required]
**Reason** | **String** | The reason comment for why the reassign was made | [required]
**Reassign** | [**[]ReassignReference**](reassign-reference) | | [required]
**ReassignTo** | **String** | The ID of the identity to which the certification is reassigned | [required]
**Reason** | **String** | The reason comment for why the reassign was made | [required]
## Examples

8
docs/tools/sdk/powershell/Reference/V3/Models/AccessSummary.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'AccessSummary']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Access** | Pointer to [**AccessSummaryAccess**](access-summary-access) | | [optional]
**Entitlement** | Pointer to [**ReviewableEntitlement**](reviewable-entitlement) | | [optional]
**AccessProfile** | Pointer to [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional]
**Role** | Pointer to [**ReviewableRole**](reviewable-role) | | [optional]
**Access** | [**AccessSummaryAccess**](access-summary-access) | | [optional]
**Entitlement** | [**ReviewableEntitlement**](reviewable-entitlement) | | [optional]
**AccessProfile** | [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional]
**Role** | [**ReviewableRole**](reviewable-role) | | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccessSummaryAccess.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'AccessSummaryA
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
**Id** | Pointer to **String** | The ID of the item being certified | [optional]
**Name** | Pointer to **String** | The name of the item being certified | [optional]
**Type** | [**DtoType**](dto-type) | | [optional]
**Id** | **String** | The ID of the item being certified | [optional]
**Name** | **String** | The name of the item being certified | [optional]
## Examples

56
docs/tools/sdk/powershell/Reference/V3/Models/Account.md
View File

@@ -16,34 +16,34 @@ tags: ['SDK', 'Software Development Kit', 'Account', 'Account']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly]
**Name** | **String** | Name of the Object | [required]
**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly]
**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly]
**SourceId** | **String** | The unique ID of the source this account belongs to | [required]
**SourceName** | **String** | The display name of the source this account belongs to | [required]
**IdentityId** | Pointer to **String** | The unique ID of the identity this account is correlated to | [optional]
**CloudLifecycleState** | Pointer to **String** | The lifecycle state of the identity this account is correlated to | [optional]
**IdentityState** | Pointer to **String** | The identity state of the identity this account is correlated to | [optional]
**ConnectionType** | Pointer to **String** | The connection type of the source this account is from | [optional]
**IsMachine** | Pointer to **Boolean** | Indicates if the account is of machine type | [optional] [default to $false]
**Recommendation** | Pointer to [**Recommendation**](recommendation) | | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The account attributes that are aggregated | [required]
**Authoritative** | **Boolean** | Indicates if this account is from an authoritative source | [required]
**Description** | Pointer to **String** | A description of the account | [optional]
**Disabled** | **Boolean** | Indicates if the account is currently disabled | [required]
**Locked** | **Boolean** | Indicates if the account is currently locked | [required]
**NativeIdentity** | **String** | The unique ID of the account generated by the source system | [required]
**SystemAccount** | **Boolean** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required]
**Uncorrelated** | **Boolean** | Indicates if this account is not correlated to an identity | [required]
**Uuid** | Pointer to **String** | The unique ID of the account as determined by the account schema | [optional]
**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [required]
**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required]
**Identity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
**SourceOwner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
**Features** | Pointer to **String** | A string list containing the owning source's features | [optional]
**Origin** | Pointer to **Enum** [ "AGGREGATED", "PROVISIONED" ] | The origin of the account either aggregated or provisioned | [optional]
**OwnerIdentity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly]
**Name** | **String** | Name of the Object | [required]
**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly]
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
**SourceId** | **String** | The unique ID of the source this account belongs to | [required]
**SourceName** | **String** | The display name of the source this account belongs to | [required]
**IdentityId** | **String** | The unique ID of the identity this account is correlated to | [optional]
**CloudLifecycleState** | **String** | The lifecycle state of the identity this account is correlated to | [optional]
**IdentityState** | **String** | The identity state of the identity this account is correlated to | [optional]
**ConnectionType** | **String** | The connection type of the source this account is from | [optional]
**IsMachine** | **Boolean** | Indicates if the account is of machine type | [optional] [default to $false]
**Recommendation** | [**Recommendation**](recommendation) | | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The account attributes that are aggregated | [required]
**Authoritative** | **Boolean** | Indicates if this account is from an authoritative source | [required]
**Description** | **String** | A description of the account | [optional]
**Disabled** | **Boolean** | Indicates if the account is currently disabled | [required]
**Locked** | **Boolean** | Indicates if the account is currently locked | [required]
**NativeIdentity** | **String** | The unique ID of the account generated by the source system | [required]
**SystemAccount** | **Boolean** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required]
**Uncorrelated** | **Boolean** | Indicates if this account is not correlated to an identity | [required]
**Uuid** | **String** | The unique ID of the account as determined by the account schema | [optional]
**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [required]
**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required]
**Identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**SourceOwner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**Features** | **String** | A string list containing the owning source's features | [optional]
**Origin** | **Enum** [ "AGGREGATED", "PROVISIONED" ] | The origin of the account either aggregated or provisioned | [optional]
**OwnerIdentity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountAction', 'AccountAction']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Action** | Pointer to **Enum** [ "ENABLE", "DISABLE" ] | Describes if action will be enabled or disabled | [optional]
**SourceIds** | Pointer to **[]String** | List of unique source IDs. The sources must have the ENABLE feature or flat file source. See ""/sources"" endpoint for source features. | [optional]
**Action** | **Enum** [ "ENABLE", "DISABLE" ] | Describes if action will be enabled or disabled | [optional]
**SourceIds** | **[]String** | List of unique source IDs. The sources must have the ENABLE feature or flat file source. See ""/sources"" endpoint for source features. | [optional]
## Examples

28
docs/tools/sdk/powershell/Reference/V3/Models/AccountActivity.md
View File

@@ -16,20 +16,20 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'AccountActivity']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Id of the account activity | [optional]
**Name** | Pointer to **String** | The name of the activity | [optional]
**Created** | Pointer to **System.DateTime** | When the activity was first created | [optional]
**Modified** | Pointer to **System.DateTime** | When the activity was last modified | [optional]
**Completed** | Pointer to **System.DateTime** | When the activity was completed | [optional]
**CompletionStatus** | Pointer to [**CompletionStatus**](completion-status) | | [optional]
**Type** | Pointer to **String** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [optional]
**RequesterIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional]
**TargetIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional]
**Errors** | Pointer to **[]String** | A list of error messages, if any, that were encountered. | [optional]
**Warnings** | Pointer to **[]String** | A list of warning messages, if any, that were encountered. | [optional]
**Items** | Pointer to [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional]
**ExecutionStatus** | Pointer to [**ExecutionStatus**](execution-status) | | [optional]
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional]
**Id** | **String** | Id of the account activity | [optional]
**Name** | **String** | The name of the activity | [optional]
**Created** | **System.DateTime** | When the activity was first created | [optional]
**Modified** | **System.DateTime** | When the activity was last modified | [optional]
**Completed** | **System.DateTime** | When the activity was completed | [optional]
**CompletionStatus** | [**CompletionStatus**](completion-status) | | [optional]
**Type** | **String** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [optional]
**RequesterIdentitySummary** | [**IdentitySummary**](identity-summary) | | [optional]
**TargetIdentitySummary** | [**IdentitySummary**](identity-summary) | | [optional]
**Errors** | **[]String** | A list of error messages, if any, that were encountered. | [optional]
**Warnings** | **[]String** | A list of warning messages, if any, that were encountered. | [optional]
**Items** | [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional]
**ExecutionStatus** | [**ExecutionStatus**](execution-status) | | [optional]
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional]
## Examples

38
docs/tools/sdk/powershell/Reference/V3/Models/AccountActivityDocument.md
View File

@@ -16,25 +16,25 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'AccountAct
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | | [required]
**Name** | **String** | | [required]
**Type** | [**DocumentType**](document-type) | | [required]
**Action** | Pointer to **String** | Type of action performed in the activity. | [optional]
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Stage** | Pointer to **String** | Activity's current stage. | [optional]
**Origin** | Pointer to **String** | Activity's origin. | [optional]
**Status** | Pointer to **String** | Activity's current status. | [optional]
**Requester** | Pointer to [**AccountSource**](account-source) | | [optional]
**Recipient** | Pointer to [**AccountSource**](account-source) | | [optional]
**TrackingNumber** | Pointer to **String** | Account activity's tracking number. | [optional]
**Errors** | Pointer to **[]String** | Errors provided by the source while completing account actions. | [optional]
**Warnings** | Pointer to **[]String** | Warnings provided by the source while completing account actions. | [optional]
**Approvals** | Pointer to [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
**Sources** | Pointer to **String** | Sources involved in the account activity. | [optional]
**Id** | **String** | | [required]
**Name** | **String** | | [required]
**Type** | [**DocumentType**](document-type) | | [required]
**Action** | **String** | Type of action performed in the activity. | [optional]
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Stage** | **String** | Activity's current stage. | [optional]
**Origin** | **String** | Activity's origin. | [optional]
**Status** | **String** | Activity's current status. | [optional]
**Requester** | [**AccountSource**](account-source) | | [optional]
**Recipient** | [**AccountSource**](account-source) | | [optional]
**TrackingNumber** | **String** | Account activity's tracking number. | [optional]
**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional]
**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional]
**Approvals** | [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
**OriginalRequests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
**ExpansionItems** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
**AccountRequests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
**Sources** | **String** | Sources involved in the account activity. | [optional]
## Examples

32
docs/tools/sdk/powershell/Reference/V3/Models/AccountActivityItem.md
View File

@@ -16,22 +16,22 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'AccountActivit
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | Item id | [optional]
**Name** | Pointer to **String** | Human-readable display name of item | [optional]
**Requested** | Pointer to **System.DateTime** | Date and time item was requested | [optional]
**ApprovalStatus** | Pointer to [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional]
**ProvisioningStatus** | Pointer to [**ProvisioningState**](provisioning-state) | | [optional]
**RequesterComment** | Pointer to [**Comment**](comment) | | [optional]
**ReviewerIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional]
**ReviewerComment** | Pointer to [**Comment**](comment) | | [optional]
**Operation** | Pointer to [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional]
**Attribute** | Pointer to **String** | Attribute to which account activity applies | [optional]
**Value** | Pointer to **String** | Value of attribute | [optional]
**NativeIdentity** | Pointer to **String** | Native identity in the target system to which the account activity applies | [optional]
**SourceId** | Pointer to **String** | Id of Source to which account activity applies | [optional]
**AccountRequestInfo** | Pointer to [**AccountRequestInfo**](account-request-info) | | [optional]
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional]
**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
**Id** | **String** | Item id | [optional]
**Name** | **String** | Human-readable display name of item | [optional]
**Requested** | **System.DateTime** | Date and time item was requested | [optional]
**ApprovalStatus** | [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional]
**ProvisioningStatus** | [**ProvisioningState**](provisioning-state) | | [optional]
**RequesterComment** | [**Comment**](comment) | | [optional]
**ReviewerIdentitySummary** | [**IdentitySummary**](identity-summary) | | [optional]
**ReviewerComment** | [**Comment**](comment) | | [optional]
**Operation** | [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional]
**Attribute** | **String** | Attribute to which account activity applies | [optional]
**Value** | **String** | Value of attribute | [optional]
**NativeIdentity** | **String** | Native identity in the target system to which the account activity applies | [optional]
**SourceId** | **String** | Id of Source to which account activity applies | [optional]
**AccountRequestInfo** | [**AccountRequestInfo**](account-request-info) | | [optional]
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional]
**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
## Examples

38
docs/tools/sdk/powershell/Reference/V3/Models/AccountActivitySearchedItem.md
View File

@@ -16,25 +16,25 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'Accoun
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | | [required]
**Name** | **String** | | [required]
**Type** | [**DocumentType**](document-type) | | [required]
**Action** | Pointer to **String** | Type of action performed in the activity. | [optional]
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Stage** | Pointer to **String** | Activity's current stage. | [optional]
**Origin** | Pointer to **String** | Activity's origin. | [optional]
**Status** | Pointer to **String** | Activity's current status. | [optional]
**Requester** | Pointer to [**AccountSource**](account-source) | | [optional]
**Recipient** | Pointer to [**AccountSource**](account-source) | | [optional]
**TrackingNumber** | Pointer to **String** | Account activity's tracking number. | [optional]
**Errors** | Pointer to **[]String** | Errors provided by the source while completing account actions. | [optional]
**Warnings** | Pointer to **[]String** | Warnings provided by the source while completing account actions. | [optional]
**Approvals** | Pointer to [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
**Sources** | Pointer to **String** | Sources involved in the account activity. | [optional]
**Id** | **String** | | [required]
**Name** | **String** | | [required]
**Type** | [**DocumentType**](document-type) | | [required]
**Action** | **String** | Type of action performed in the activity. | [optional]
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**Stage** | **String** | Activity's current stage. | [optional]
**Origin** | **String** | Activity's origin. | [optional]
**Status** | **String** | Activity's current status. | [optional]
**Requester** | [**AccountSource**](account-source) | | [optional]
**Recipient** | [**AccountSource**](account-source) | | [optional]
**TrackingNumber** | **String** | Account activity's tracking number. | [optional]
**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional]
**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional]
**Approvals** | [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
**OriginalRequests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
**ExpansionItems** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
**AccountRequests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
**Sources** | **String** | Sources involved in the account activity. | [optional]
## Examples

18
docs/tools/sdk/powershell/Reference/V3/Models/AccountAttribute.md
View File

@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttribute', 'AccountAttribute'
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**SourceName** | **String** | A reference to the source to search for the account | [required]
**AttributeName** | **String** | The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. | [required]
**AccountSortAttribute** | Pointer to **String** | The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries | [optional] [default to "created"]
**AccountSortDescending** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) | [optional] [default to $false]
**AccountReturnFirstLink** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false | [optional] [default to $false]
**AccountFilter** | Pointer to **String** | This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements | [optional]
**AccountPropertyFilter** | Pointer to **String** | This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. | [optional]
**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false]
**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional]
**SourceName** | **String** | A reference to the source to search for the account | [required]
**AttributeName** | **String** | The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. | [required]
**AccountSortAttribute** | **String** | The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries | [optional] [default to "created"]
**AccountSortDescending** | **Boolean** | The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) | [optional] [default to $false]
**AccountReturnFirstLink** | **Boolean** | The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false | [optional] [default to $false]
**AccountFilter** | **String** | This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements | [optional]
**AccountPropertyFilter** | **String** | This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. | [optional]
**RequiresPeriodicRefresh** | **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false]
**VarInput** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'AccountAttribute
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The schema attribute values for the account | [required]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The schema attribute values for the account | [required]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'AccountAtt
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required]
**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', '
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**SourceId** | **String** | Target source to create an account | [required]
**SourceId** | **String** | Target source to create an account | [required]
## Examples

12
docs/tools/sdk/powershell/Reference/V3/Models/AccountRequest.md
View File

@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'AccountRequest']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountId** | Pointer to **String** | Unique ID of the account | [optional]
**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | | [optional]
**Op** | Pointer to **String** | The operation that was performed | [optional]
**ProvisioningTarget** | Pointer to [**AccountSource**](account-source) | | [optional]
**Result** | Pointer to [**AccountRequestResult**](account-request-result) | | [optional]
**Source** | Pointer to [**AccountSource**](account-source) | | [optional]
**AccountId** | **String** | Unique ID of the account | [optional]
**AttributeRequests** | [**[]AttributeRequest**](attribute-request) | | [optional]
**Op** | **String** | The operation that was performed | [optional]
**ProvisioningTarget** | [**AccountSource**](account-source) | | [optional]
**Result** | [**AccountRequestResult**](account-request-result) | | [optional]
**Source** | [**AccountSource**](account-source) | | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccountRequestInfo.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'AccountRequestI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RequestedObjectId** | Pointer to **String** | Id of requested object | [optional]
**RequestedObjectName** | Pointer to **String** | Human-readable name of requested object | [optional]
**RequestedObjectType** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional]
**RequestedObjectId** | **String** | Id of requested object | [optional]
**RequestedObjectName** | **String** | Human-readable name of requested object | [optional]
**RequestedObjectType** | [**RequestableObjectType**](requestable-object-type) | | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccountRequestResult.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'AccountReques
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Errors** | Pointer to **[]String** | | [optional]
**Status** | Pointer to **String** | The status of the account request | [optional]
**TicketId** | Pointer to **String** | | [optional]
**Errors** | **[]String** | | [optional]
**Status** | **String** | The status of the account request | [optional]
**TicketId** | **String** | | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccountSource.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountSource', 'AccountSource']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
**Type** | Pointer to **String** | Type of source returned. | [optional]
**Id** | **String** | The unique ID of the referenced object. | [optional]
**Name** | **String** | The human readable name of the referenced object. | [optional]
**Type** | **String** | Type of source returned. | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'AccountToggle
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ExternalVerificationId** | Pointer to **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
**ForceProvisioning** | Pointer to **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. | [optional]
**ExternalVerificationId** | **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
**ForceProvisioning** | **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. | [optional]
## Examples

6
docs/tools/sdk/powershell/Reference/V3/Models/AccountUnlockRequest.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'AccountUnlock
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ExternalVerificationId** | Pointer to **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
**UnlockIDNAccount** | Pointer to **Boolean** | If set, the IDN account is unlocked after the workflow completes. | [optional]
**ForceProvisioning** | Pointer to **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
**ExternalVerificationId** | **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
**UnlockIDNAccount** | **Boolean** | If set, the IDN account is unlocked after the workflow completes. | [optional]
**ForceProvisioning** | **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'AccountUsage']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Date** | Pointer to **System.DateTime** | The first day of the month for which activity is aggregated. | [optional]
**Count** | Pointer to **Int64** | The number of days within the month that the account was active in a source. | [optional]
**Date** | **System.DateTime** | The first day of the month for which activity is aggregated. | [optional]
**Count** | **Int64** | The number of days within the month that the account was active in a source. | [optional]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'AccountsAsyncR
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | id of the task | [required]
**Id** | **String** | id of the task | [required]
## Examples

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'Acco
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Application** | **String** | Source ID. | [required]
**SourceName** | **String** | Source name. | [required]
**Application** | **String** | Source ID. | [required]
**SourceName** | **String** | Source name. | [required]
## Examples

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'ActivateCa
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TimeZone** | Pointer to **String** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"]
**TimeZone** | **String** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"]
## Examples

Some files were not shown because too many files have changed in this diff Show More